Skip to content

Latest commit

 

History

History
78 lines (64 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

78 lines (64 loc) · 3.58 KB

Contributing

This document contains a set of guidelines to help you during the contribution process. We are happy to welcome all contributions from anyone willing to improve this project. Thank you for helping out and remember, no contribution is too small.

Step By Step Contribution Guide

  1. 📝 Open an Issue: Before you start working on any changes, open a new issue to discuss the problem you want to solve or the feature you want to add. This helps avoid duplication of efforts and ensures that your contribution aligns with the project's goals.
  2. ⚙️ Install Prerequisites: Make sure you have all the necessary prerequisites installed to set up the project locally. Refer to the project's README or documentation for detailed instructions. This project contains a Devcontainer that includes all the necessary prerequisites to set up the project.
  3. 🌱 Create a Git Branch: Create a new Git branch for your work and make your changes on this branch. It's good practice to name your branch according to the type of contribution, such as "feature/your-feature-name" or "bugfix/issue-number".
  4. 🧪 Add and Run Tests: If applicable, add new tests or update existing ones to ensure the code's correctness and reliability. Before submitting your contribution, make sure all tests pass successfully.
  5. 🗒️ Add or Update Documentation: Keep the project's documentation up-to-date. If you add a new feature or make significant changes, update the relevant documentation to help other users and contributors understand your work.
  6. 📜 Commit: We follow a specific format for Git commit messages to maintain a clear and informative project history. Please adhere to the following rules:
    • Separate the subject from the body with a blank line.
    • Limit the subject line to 50 characters.
    • Capitalize the subject line.
    • Do not end the subject line with a period.
    • Use the imperative mood in the subject line.
    • Wrap the body at 72 characters.
    • Use the body to explain what and why, not how.
  7. 📤 Push and Create Pull Request: Once your changes are ready, push your branch to the repository and create a pull request for review. Provide a clear description of your changes in the pull request, referencing the issue it addresses, if applicable.
  8. 💬 Communicate and Review: Be responsive during the review process and engage in discussions with the maintainers. Be open to feedback and make necessary changes to address review comments.
  9. Your contribution gets accepted. 🎉🎉🎉

NOTE: Be sure to get the latest from "upstream" before making a pull request!

Issues

Before creating a new issue, please search for similar issues, open or closed, to see if someone else has already noticed the same problem and possible solutions.

Do not comment on open issues unless you can provide more information to resolve them. Use the subscribe function to keep up-to-date with the issue or the voting system to support it.

🐛 Bug reports

When you can't find a previous bug, open an issue keeping in mind the following considerations:

  • Try to reproduce the bug using the code found on the main branch
  • Copy and paste the full error message, including the backtrace
  • Be as detailed as possible and include any additional information

🚀 Feature requests

If you want to request or implement a new feature please submit an issue describing the details and possible use cases.

Thanks

Thank you to all who have contributed to this great project.