Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (79 loc) · 3.23 KB

CONTRIBUTING.md

File metadata and controls

116 lines (79 loc) · 3.23 KB

Contributing

Thank you for considering contributing! Contributions, whether big or small, are always welcome. Below are guidelines to help you get started.

📚 Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Issues and Bug Reports
  4. Feature Requests
  5. Development Guidelines
  6. Pull Requests
  7. License

📜 Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please ensure that you read and understand it.

🛠️ How to Contribute

  1. Fork the repository on GitHub.

  2. Set up the Dev Container (Recommended Method)

    • Create a GitHub Codespace (Code->Codespaces in the GitHub web console of your cloned repository) OR click on the "Open in Devcontainer" link in the Readme

  3. Make Your Changes

    • Create a branch for your feature or bug fix: 
      git checkout -b feature/your-feature-name
    • Make your changes and test them within the dev container.

  4. Commit Your Changes

    git add .
git commit -m "Add your detailed commit message"

  5. Push Your Changes

    git push origin feature/your-feature-name

  6. Open a Pull Request (PR)

    • Go to the original repository on GitHub.
    • Click "New Pull Request".
    • Fill in the PR template and submit.

🐳 Why Use the Dev Container?

  • Pre-configured environment ensures consistency across development setups.
  • No need to manually install dependencies locally.
  • Simplifies debugging and testing workflows.

If you encounter issues with the dev container, feel free to raise an Issue.

🐞 Issues and Bug Reports

If you encounter a bug or issue:

  • Check if it’s already reported in the Issues section.
  • If not, open a new issue with:
    • A clear and descriptive title.
    • Steps to reproduce the issue.
    • Expected and actual behavior.
    • Any relevant logs, screenshots, or environment details.

💡 Feature Requests

We love hearing new ideas! If you have an idea for a feature:

  • Search existing issues to ensure it hasn't been suggested already.
  • Open a new Feature Request issue and describe:
    • What the feature does.
    • Why it’s beneficial.
    • How you envision it being implemented.

🧑‍💻 Development Guidelines

  • Follow the project's code style.
  • Write clear and descriptive commit messages.
  • Use Test Driven Development when adding new features or fixing bugs.
  • Keep changes focused; avoid mixing unrelated changes in one pull request.

🔄 Pull Requests

  • Ensure your pull request is focused on a single feature or bug fix.
  • Reference the issue your pull request addresses (if applicable).
  • Update documentation if your changes require it.
  • Be ready to address feedback or changes requested during code review.

📜 License

By contributing, you agree that your contributions will be licensed under the same license as the project: LICENSE.

Thank you for your contribution! 🚀

If you have any questions, feel free to raise an Issue. 😊