Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (37 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

55 lines (37 loc) · 2.14 KB
Raw

Contributing to This Project

First off, thank you for considering contributing to this project! It’s people like you that make the open-source community such an amazing place to learn, inspire, and create.

Please take a moment to review this document to understand our contribution process.

🚀 How to Contribute

We use a standard Fork and Branch workflow for this repository. Please follow these steps to propose changes:

1. Fork the Repository

Click the Fork button at the top right of this GitHub page to create a copy of this repository under your own GitHub account.

2. Clone Your Fork

Clone your fork to your local machine: git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY-NAME.git

3. Create a Feature Branch

Never work directly on the master branch. Create a new, descriptively named branch for your changes: git checkout -b feature/your-feature-name OR for bug fixes: git checkout -b fix/bug-description

4. Make Your Changes & Commit

Write your code, fix the bug, or add the feature. When you are ready, save your changes with a clear commit message: git add . git commit -m "A short, descriptive message explaining what you changed"

5. Push to Your Fork

Push your new branch up to your GitHub fork: git push origin feature/your-feature-name

6. Open a Pull Request (PR)

  1. Go to the original repository on GitHub.
  2. You should see a green button that says "Compare & pull request". Click it.
  3. Describe your changes in the PR description (what you did and why).
  4. Submit the Pull Request!

📝 Code of Conduct & Guidelines

  • Keep PRs focused: Please try to keep your Pull Requests focused on a single fix or feature. If you want to do multiple things, open separate branches and PRs.
  • Be respectful: This is a welcoming environment. Please be kind and constructive in your comments and reviews.
  • Test your code: Before submitting, make sure your changes work as intended and don't accidentally break existing features.

❓ Need Help?

If you have any questions, feel free to open an Issue on GitHub, and we can discuss it there!

*This contribution file was written by an LLM