Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.87 KB

CONTRIBUTING.md

File metadata and controls

43 lines (30 loc) · 1.87 KB

Contributing to Faable

Thanks for helping out. Bug reports, fixes and documentation improvements are all welcome.

Please follow our code of conduct. For questions, see SUPPORT.md. To report a vulnerability, see SECURITY.md.

Reporting a bug

Search the repository's issues first, then open a new one with the steps to reproduce it, what you expected and what happened. Remove secrets, tokens and customer data from any logs you paste.

Suggesting a change

For anything bigger than a small fix, open an issue before you write the code. It is the quickest way to find out whether the change fits and how to approach it.

Sending a pull request

  1. Fork the repository and create a branch from main.
  2. Follow the setup steps in the repository's README.
  3. Keep the change focused, and add or update tests when the behavior changes.
  4. Update the README or the documentation if users will notice the change.
  5. Write in English: code, comments, commit messages and documentation.
  6. Open the pull request and describe what changed and why.

Commit messages

We use Conventional Commits. Releases are automated, so the type decides what happens next:

Type Effect
fix: Publishes a patch release
feat: Publishes a minor release
docs:, refactor:, test:, chore: Does not publish anything

License

Contributions are made under the license of the repository you contribute to. In a repository without a license, such as docs, you agree that Faable may publish your contribution as part of its content.