diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 10 insertions, 11 deletions
@@ -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 |