Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (22 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

33 lines (22 loc) · 2.98 KB

Contributing to Mustermann

Contributions to Mustermann are welcome and appreciated! 💜💜💜

To ensure a smooth contribution process, please follow these guidelines:

  1. Do not open issues or pull requests regarding open security vulnerabilities. If you discover a security vulnerability, please report follow the Sinatra security policy.
  2. Bug reports and pull requests should be submitted to the main repository on GitHub.
  3. Please follow the code of conduct in all your interactions with the project and its community.
  4. If you use an AI tool to assist with your contribution, please follow the guidelines outlined in the AI contribution policy below.
  5. Any code contributions added to Mustermann directly should be licensed under the MIT License. By submitting a pull request, you are agreeing to license your contribution under the MIT License. This does not apply to third-party plugins, repositories, redistributions, or other works that you may link to or reference in your contribution, which may be subject to their own licenses.
  6. Run bin/rake and make sure it's happy before submitting a pull request. If your contribution includes new features, please also add tests and documentation as needed.
  7. We aim for 100% test coverage. Don't let that deter you from contributing! If your contribution doesn't have tests, we can help you add them.

You can find documentation for the project in the docs directory.

Feel free to reach out with any questions and feedback.

Thank you for being part of the Ruby Open Source community and for contributing to Mustermann! 🙌

AI contribution policy

If you wish to use an AI tool for assistance, please adhere to the following guidelines:

  • As a contributor, you are always the author and fully accountable for your contributions.
  • You must carefully read and review all LLM-generated code or text before asking maintainers to review it. This includes pull request descriptions, where we want to hear your personal voice rather than an unfiltered AI summary.
  • You should be transparent and make note if your contribution contains substantial amounts of tool-generated content.
  • You should be confident that your contribution is high enough quality to merit a maintainer’s time for review. You should be able to answer questions about your work during review.
  • You are responsible for ensuring you have the legal right to make your contribution under our license, and that your contribution does not violate the intellectual property rights of any third party.

Any agents used for contributions may not take action without human review and approval. This includes, but is not limited to, making commits, opening pull requests, or posting in issue trackers.

This policy is based on the Hanami AI contribution policy.