From a631d950e1b413b10d95bfd9c92f7bb79862395a Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Mon, 5 Mar 2018 20:57:57 +0530 Subject: [PATCH] Add a guide to contributing --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..5e5107020 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +Install [the dependencies](https://github.com/kovidgoyal/kitty#dependencies) +using your favorite package manager. Build and run kitty [from +source](https://github.com/kovidgoyal/kitty#install-and-run-from-source). + +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.