aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-03-06 03:11:45 +0800
committerGravatar Runxi Yu2026-03-06 03:11:45 +0800
commita9d9ca76b16ce9f90487f8b4f78ddbef708d4995 (patch)
treef147d3d3fb36cb48fe42e83ebd8898c6bcbfe3f5 /README.md
parentobjectstored: Split (diff)
signatureNo signature
README: Software reproduction language
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 10 insertions, 11 deletions
diff --git a/README.md b/README.md
index 52945e23..0a2376b8 100644
--- a/README.md
+++ b/README.md
@@ -125,19 +125,18 @@ Mainly tests the packfile object reader.
## 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.
+Bug reports ideally include a reproduction recipe: a Go program which starts
+out with an empty repository and calls Furgit and/or Git commands to trigger
+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.
+Please 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.
+If writing an automated test really turns out to be impossible, please explain
+in very clear terms how the problem can be reproduced.
## License