Thank you for considering to contribute to bat!
If your contribution changes the behavior of bat (as opposed to a typo-fix
in the documentation), please update the CHANGELOG.md file
and describe your changes. This makes the release process much easier and
therefore helps to get your changes into a new bat release faster.
The top of the CHANGELOG contains a "unreleased" section with a few
subsections (Features, Bugfixes, …). Please add your entry to the subsection
that best describes your change.
Entries follow this format:
- Short description of what has been changed, see #123 (@user)
Here, #123 is the number of the original issue and/or your pull request.
Please replace @user by your GitHub username.
Please check out the Development section in the README.
Please consider opening a feature request ticket first in order to give us a chance to discuss the feature first.
Before you make a pull request that adds a new syntax or theme, please read the Customization section in the README first.
If you really think that a particular syntax or theme should be added for all users, please read the corresponding documentation first.
You are strongly encouraged to add regression tests. Regression tests are great, not least because they:
-
ensure that your contribution will never completely stop working,
-
makes code review easier, because it becomes very clear what the code is supposed to do.
For functional changes, you most likely want to add a test to
tests/integration_tests.rs.
Look at existing tests to know how to write a new test. In short, you will
invoke the bat binary with a certain set of arguments, and then assert on
stdout/stderr.
To learn how to write regression tests for theme and syntax changes, read the
Syntax
tests
section in assets.md.