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
Fork the Repository: Click the
Fork
button at the top right corner of this page.Clone Your Fork:
git clone https://github.com/your-username/30-Days-Of-Rust.git
Navigate to the Directory:
cd 30-Days-Of-Rust
Create a Branch:
git checkout -b feature/your-feature-name
Tip: Use descriptive branch names like
fix/documentation-typos
orfeature/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
Sync with Upstream: Before submitting, ensure your branch is up to date with the main branch.
git fetch upstream git merge upstream/main
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.
Review & Feedback:
Be open to feedback. Weβre all here to learn and grow.
Address requested changes promptly.
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