Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: enhance contributing guidelines #1268

Merged
merged 1 commit into from
Feb 4, 2025
Merged

docs: enhance contributing guidelines #1268

merged 1 commit into from
Feb 4, 2025

Conversation

sasa-tomic
Copy link
Member

Key Updates

  • Added Badges:

    • Contributions Welcome
    • Python Manager (Rye)
    • Pre-commit Enabled

  • Updated Table of Contents:

    • Added sections for Code Style Guidelines, Pull Request Process, Common Issues, and Getting Help.

  • Added Code Style Guidelines:

    • Included specific guidelines for Python (PEP 8), Rust, and JavaScript/TypeScript.

  • Defined Development Workflow:

    • Detailed steps for contributing, including forking, branch creation, development setup, and pull request creation.

  • Outlined Pull Request Process:

    • Steps for submitting a PR, including testing, documentation updating, linking issues, and review actions.

  • Expanded Common Issues Section:

    • Added detailed steps for handling permission errors, node version mismatches, and Bazel cache issues.

  • Enhanced Getting Help Section:

    • Instructions for checking existing issues, documentation, and joining community channels.

  • Cosmetic and Structure Improvements:

    • Emojis and icons added to enhance readability and structure consistency.

@sasa-tomic
docs: enhance contributing guidelines
d2335fc 
### Changes

- Added badges to the contributing document for contributions, Python manager, and pre-commit.
- Introduced new sections and emojis for visual clarity:
  - 📚 Table of Contents
  - 🛠 Development Environment Setup
  - 📂 Project Structure
  - 📝 Code Style Guidelines (detailing Python, Rust, and JavaScript/TypeScript standards)
  - 🔄 Development Workflow (step-by-step guide with command examples)
  - 🔍 Pull Request Process (includes PR title format guidelines)
  - ⚡ Running Tests
  - ❗ Common Issues (added examples and solutions for common errors)
  - 🤝 Getting Help (tips for self-troubleshooting and seeking support)

- Updated content for each section to include more detailed guidelines and best practices.
- Enhanced clarity and visual appeal of the document for contributors.
@sasa-tomic sasa-tomic requested a review from a team as a code owner February 4, 2025 17:48
@sasa-tomic sasa-tomic self-assigned this Feb 4, 2025
@sasa-tomic sasa-tomic merged commit 5e9a929 into main Feb 4, 2025
5 checks passed
@sasa-tomic sasa-tomic deleted the update/contributing-docs branch February 4, 2025 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NikolaMilosa NikolaMilosa NikolaMilosa approved these changes

Assignees

@sasa-tomic sasa-tomic

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sasa-tomic @NikolaMilosa