Skip to content

Latest commit

 

History

History
27 lines (20 loc) · 918 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 918 Bytes
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make by opening an issue. Discussing the design before implementing a big feature can result in a much better and cleaner implementation.

Pull Request Checklist

Please ensure your PR meets the following requirements:

  • Commits must be signed-off by the committer. For example:

    This is my commit message

Signed-off-by: Random J Developer <random@developer.example.org>

    Git has a -s command line option to append this automatically to your commit message:

    $ git commit -s -m 'This is my commit message'

  • CI tests must be passing. The CI tests run when you make a PR, but you can also run them on your fork (since we use GitHub Actions), or locally on your machine.

  • Documentation must be updated, if you added a new user-facing option.