Skip to content

Latest commit

 

History

History
15 lines (10 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

15 lines (10 loc) · 1.77 KB

Contributing

Thank you for your interest in Kaeso. Ideas and questions are welcome in Discussions, bug reports and concrete feature requests in issues. Pull requests from outside contributors are reviewed at the maintainer's discretion; for anything larger than a small fix, open an issue first so the approach can be agreed.

Everything about working on Kaeso is in the documentation:

  • Local setup: from a fresh clone to a running stack and passing tests.
  • Contributing: how to make a change and the rules every change follows.
  • Testing: every suite and what must pass before a change is done.
  • Writing documentation and translations: pages and words in English, German and Simplified Chinese.
  • Releasing: versions, the changelog and what a release publishes.

The short version: branch from dev, write a failing test and then the code, title the pull request with the sentence that should stand in the changelog, which the release writes from merged pull requests, run the definition of done in AGENTS.md, and open a pull request into dev with the template filled in. prod only moves through releases, which the maintainer makes.

Report vulnerabilities privately as described in SECURITY.md, never in a public issue. Everyone taking part follows the Code of Conduct. By contributing you agree that your contributions are licensed under the MIT License.