2018-03-05 18:33:01 +03:00
|
|
|
### 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.
|
2018-03-05 18:33:01 +03:00
|
|
|
|
|
|
|
|
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).
|
|
|
|
|
|
2023-01-16 14:46:58 +03:00
|
|
|
Note that bugs and feature requests are often closed quickly as they are either
|
2023-06-14 00:39:53 +03:00
|
|
|
fixed or deemed wontfix/invalid. In my experience, this is the only scalable way to
|
2023-01-16 14:46:58 +03:00
|
|
|
manage a bug tracker. Feel free to continue to post to a closed bug report
|
|
|
|
|
if you would like to discuss the issue further. Being closed does not mean you
|
|
|
|
|
will not get any more responses.
|
2018-03-05 18:33:01 +03:00
|
|
|
|
|
|
|
|
### Contributing code
|
|
|
|
|
|
2021-07-27 06:33:11 +03:00
|
|
|
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
|
2021-07-27 06:33:11 +03:00
|
|
|
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.
|
