Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

90 lines (58 loc) · 3.63 KB



Contributing

If you're reading this file, it means you're interested in contributing to this repository. You are more than welcome!

Before proceeding, please take a moment to read and understand this contribution guide to ensure smooth collaboration.

Etiquette

This project is open source. The maintainers dedicate their free time to building, improving, and maintaining the codebase, making it freely available for everyone to use. Their contribution is an act of generosity, and they hope the project will be helpful to others.

When interacting with maintainers (e.g., opening issues or submitting pull requests), please be respectful and considerate. Remember:

  • Open source thrives on collaboration and mutual respect.
  • Feedback and reviews are intended to promote quality, not personal criticism.
  • If your contribution is not accepted, avoid frustration—decisions are made based on the benefit to the project and its broader audience.

Let’s collaborate constructively and showcase how developers support one another!

Contribution Guidelines

Reporting Issues and Requesting Features

Before creating an issue:

  1. Replicate the problem you’re experiencing to ensure it isn’t a one-time occurrence.
  2. Search existing issues to check if it has already been reported or discussed.
  3. Verify ongoing work by checking pull requests to see if:
    • There is already a solution in progress.
    • The feature you want to request is already being implemented.

When opening an issue:

  • Provide a clear and detailed description of the problem or feature request.
  • Include steps to reproduce the issue (if applicable).
  • Share any relevant logs, screenshots, or additional details to help with debugging or understanding the request.

Submitting Pull Requests

We welcome contributions to the codebase via pull requests! Here’s how to get started:

  1. Check for previous work:

    • Verify that your feature or fix has not already been submitted as a pull request.
    • Make sure the codebase doesn’t already include your change.

  2. Stick to one change per pull request:

    • If you plan to address multiple features or fixes, open separate pull requests for each one.

  3. Ensure a clear commit history:

    • Each commit should represent a meaningful change.
    • If you have multiple commits for a single feature or fix, squash them into one before submitting.

  4. Add tests:

    • Contributions without tests will not be accepted.
    • Ensure that your tests cover all edge cases and maintain the quality of the project.

  5. Keep documentation updated:

    • Update README.md and any other relevant documents to reflect your changes.

  6. Consider the release cycle:

Additional Requirements

This project may have specific requirements, which will always be listed here as they apply.

  • Testing: Any new code must include adequate test coverage. Pull requests that lack tests will not be merged.

  • Pull Request Details: Include sufficient context and explanation in your pull request description. Maintain a consistent and meaningful commit history.

Final Words

Thank you again for wanting to contribute to this project! Your ideas and help are invaluable and make the open source ecosystem stronger.

We look forward to your contributions. Happy coding! 🎉