From 3459c55ebfb1f600cb0d850961658d841db0eff0 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Mon, 5 Mar 2018 21:03:01 +0530 Subject: [PATCH] Add section on reporting bugs to CONTRIBUTING --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e5107020..6cbfbbaf9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,15 @@ +### Reporting bugs + +Please first search existing bug reports (especially closed ones) for a report +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://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).