CONTRIBUTING


🀝 Contributing to 30 Days of Rust

We’re excited to have you contribute to 30 Days of Rust! Whether it’s fixing a bug, adding a feature, or improving documentation, your input helps make this project a better resource for Rustaceans everywhere. Please take a moment to read through these guidelines to get started.

πŸ› οΈ Getting Started

  1. Fork the Repository: Click the Fork button at the top right corner of this page.

  2. Clone Your Fork:

    git clone https://github.com/your-username/30-Days-Of-Rust.git
  3. Navigate to the Directory:

    cd 30-Days-Of-Rust
  4. Create a Branch:

    git checkout -b feature/your-feature-name

    Tip: Use descriptive branch names like fix/documentation-typos or feature/add-day10-exercises.

πŸš€ Code Contribution

  • Follow the Code Style: Consistent coding helps maintain readability. Please adhere to the existing style guide.

  • Write Tests: For new features, ensure to write comprehensive tests and check that all existing tests pass.

  • Commit Guidelines:

    • Use clear and concise messages:

      • βœ… Add feature for async task handling

      • βœ… Fix input validation in CLI parser

      • ❌ Updated stuff

    • Commit often, but make sure each commit represents a single logical change.

πŸ“– Documentation

  • Update relevant markdown files (README, day-specific guides) for new features or significant changes.

  • Clear, concise, and thorough documentation ensures everyone can benefit from your contributions. ✨

πŸ“ Need Help with Documentation?

Feel free to refer to existing sections for style and formatting or ask in our community discussions.

πŸ“¬ Pull Request Process

  1. Sync with Upstream: Before submitting, ensure your branch is up to date with the main branch.

    git fetch upstream
    git merge upstream/main
  2. Submit Your PR:

    • Provide a detailed description of your changes.

    • Link relevant issues if your PR is related to any.

    • Use the PR template to ensure all necessary details are included.

  3. Review & Feedback:

    • Be open to feedback. We’re all here to learn and grow.

    • Address requested changes promptly.

  4. Clean Commit History:

    • Squash commits if needed, for a clean and concise commit history.

πŸ’‘ Tips for Effective Contributions

  • Engage with the Community: Join discussions, ask questions, and share ideas.

  • Start with Easy Issues: Check out issues labeled good first issue if you're new to open-source contributions.

  • Be Respectful: We’re building a welcoming environment. Please follow our Code of Conduct.

Thank you for contributing! 🧑 Every bit of effort makes a difference, and together, we’re creating something awesome! Let’s continue to grow the Rustacean community. πŸ¦€πŸš€

Last updated