diff options
| -rw-r--r-- | CONTRIBUTING.md | 43 | ||||
| -rw-r--r-- | README.md | 21 |
2 files changed, 32 insertions, 32 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7b332cfe..78a97fcc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,24 +12,31 @@ Refer to the README for community spaces. ## Reporting bugs -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. Feel free to ask for help writing them. +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. +Feel free to ask for help writing them. Choose any one of: * [Open an issue on Codeberg](https://codeberg.org/lindenii/furgit/issues/new/choose) -* Sending email to [my public inbox](https://lists.sr.ht/~runxiyu/public-inbox) +* Send email to [my public inbox](https://lists.sr.ht/~runxiyu/public-inbox) * [Open an issue on GitHub](https://github.com/runxiyu/furgit/issues/new/choose) ## Submitting changes -When fixing a bug, please write a regression test in a separate commit before -your fix. Demonstrate that the regression test fails and that your fix lets it -succeed. Obviously, the regression test must be reasonable, demonstrate a real -issue (however minor), and must not itself contain hacks solely designed for -the purposes of making the old code fail and the new one succeed. Feel free to -ask for help writing regression tests. +When fixing a bug, +please write a regression test in a separate commit before your fix. +Demonstrate that the regression test originally fails +and that your fix lets it succeed. +The regression test must be reasonable, +demonstrate a real issue (however minor), +and must not itself contain hacks +solely designed for the purposes of +making the old code fail +and making the new one succeed. +Feel free to ask for help writing them. Choose any one of: @@ -40,13 +47,17 @@ Choose any one of: ## DCO sign-off -For the purposes of the Developer Certificate of Origin, the "open source -license" refers to the GNU Affero General Public License, Version 3.0, with -the above proxy designation in the README, pursuant to Section 14. +For the purposes of the Developer Certificate of Origin, +the "open source license" +refers to the GNU Affero General Public License, Version 3.0, +with the proxy designation in the README, +pursuant to Section 14. -All contributors are required to "sign‐off" their commits (using `git commit --s`) to indicate that they have agreed to the [Developer Certificate of -Origin](https://developercertificate.org), reproduced below. +All contributors are required to "sign‐off" their commits +(using `git commit -s`) +to indicate that they have agreed to the +[Developer Certificate of Origin](https://developercertificate.org), +reproduced below. ``` Developer Certificate of Origin @@ -3,24 +3,13 @@ [](https://builds.sr.ht/~runxiyu/furgit/commits/next) [](https://pkg.go.dev/codeberg.org/lindenii/furgit) -Furgit is a low‐level Git library in Go. - -Please refer to the API reference. +A low‐level Git plumbing library in Go. ## Status -* Years or decades away from stable -* Absolutely no guarantees -* Do not use in production -* Mature alternative: [go-git](https://github.com/go-git/go-git) -* Will use [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) starting at 1.0.0 - -## Goals - -* General‐purpose Git plumbing library for UNIX‐like systems -* Aim for extremely clear and modular architecture -* Then aim for high performance -* Expect familiarity with Git internals +* This `next` branch is work in progress. +* Early development, not suitable for production. +* Mature alternative: [go-git](https://github.com/go-git/go-git). ## Community @@ -29,7 +18,7 @@ Please refer to the API reference. * [#lindenii](https://web.libera.chat/#lindenii) on [Libera.Chat](https://libera.chat) -See `CONTRIBUTING.md` for bug reports and patch submissions. +See also `CONTRIBUTING.md`. ## Acknowledgements |