From 5931aad6cb6cdf32cc281544a29006c568d46214 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Wed, 25 Mar 2026 16:03:48 +0000 Subject: README: Split off contrib, benchmarks, remove history for now I guess, etc. --- CONTRIBUTING.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 89 insertions(+) create mode 100644 CONTRIBUTING.md (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c0fefe38 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,89 @@ +# Contributing + +Refer to the README for community spaces. + +## Repos and mirrors + +* [Codeberg](https://codeberg.org/lindenii/furgit) +* [SourceHut mirror](https://git.sr.ht/~runxiyu/furgit) +* [tangled mirror](https://tangled.org/@runxiyu.tngl.sh/furgit) +* [GitHub mirror](https://github.com/runxiyu/furgit) +* [git.runxiyu.org mirror](https://git.runxiyu.org/furgit.git//) + +## 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. + +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. + +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) +* [Open an issue on GitHub](https://github.com/runxiyu/furgit/issues/new/choose) + +## Submitting changes + +* Open a [pull request on Codeberg](https://codeberg.org/lindenii/furgit/pulls) +* [Send a patch](https://git-send-email.io) to + [my public inbox](https://lists.sr.ht/~runxiyu/public-inbox) +* Open a [pull request on GitHub](https://github.com/runxiyu/furgit/pulls) + +## Licensing + +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. + +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 +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. +``` -- cgit v1.3.1-10-gc9f91