kitty/CONTRIBUTING.md

26 lines
958 B
Markdown
Raw Normal View History

### Reporting bugs
Please first search existing bug reports (especially closed ones) for a report
2020-07-02 11:52:03 +03:00
that matches your issue.
When reporting a bug, provide full details of your environment, that means, at
a minimum, kitty version, OS and OS version, kitty config (ideally a minimal
config to reproduce the issue with).
### Contributing code
Install [the dependencies](https://sw.kovidgoyal.net/kitty/build/#dependencies)
2018-03-05 18:27:57 +03:00
using your favorite package manager. Build and run kitty [from
source](https://sw.kovidgoyal.net/kitty/build/#install-and-run-from-source).
2018-03-05 18:27:57 +03:00
Make a fork, submit your Pull Request. If it's a large/controversial change, open an issue
beforehand to discuss it, so that you don't waste your time making a pull
request that gets rejected.
If the code you are submitting is reasonably easily testable, please contribute
tests as well (see the `kitty_tests/` sub-directory for existing tests, which
can be run with `./test.py`).
That's it.