From 4d0cc2babd58ae8a5680eaee0e2351e11460053c Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 15 Feb 2026 04:05:23 +0800 Subject: README: Add a variation of Got's bug reporting guidelines --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index da843195..c91c3032 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,22 @@ A standard UNIX-like filesystem with * I was thinking of names and I accidentally typed "git" as "fur" (i.e., left shifted one key on my QWERTY keyboard), so, "Furgit" +## Reporting bugs + +All problem/bug reports should include a reproduction recipe in form +of a Go program which starts out with an empty repository and runs a +series of Furgit functions/methods and/or Git commands to trigger the +problem, be it a crash or some other undesirable behavior. + +Please take this request very seriously; Ask for help with writing your +regression test before asking for your problem to be fixed. Time invested in +writing a regression test saves time wasted on back-and-forth discussion about +how the problem can be reproduced. A regression test will need to be written in +any case to verify a fix and prevent the problem from resurfacing. + +If writing an automated test really turns out to be impossible, please +explain in very clear terms how the problem can be reproduced. + ## License This project is licensed under the GNU Affero General Public License, -- cgit v1.3.1-10-gc9f91