From 2aa2ff63f0ff09c7a048d415e7940dda16b2c373 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Dachary?= Date: Sat, 17 Dec 2022 14:06:28 +0100 Subject: [PATCH] [DOCS] CONTRIBUTING Refs: https://codeberg.org/forgejo/forgejo/issues/8 Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/153 Refs: https://codeberg.org/forgejo/forgejo/issues/123 Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/299 (cherry picked from commit 08dcef0c8cc9cdf5d786a925f18c1ec0cf3364da) [DOCS] CONTRIBUTING/RELEASE: https://forgejo.org/docs/admin Because the version is not displayed on the landing page of Forgejo, there cannot be a link to a versionned documentation. There must exist a link that points to the latest version on the website for the forgejo instance to display. Better but more complicated approaches could be to: * Embed the documentation in Forgejo * Allow the admin to not display the help * Allow the admin to display a versionned help or not (cherry picked from commit 83cc38923935dcc7edca22756d6fc10988a58540) (cherry picked from commit 5df52b8a4f6ebd184999a19dd10138a8e3980869) (cherry picked from commit 9a66b3d70b6e7d2a3ee146d3708d48d8f9bfe305) [DOCS] CONTRIBUTING/RELEASE: reminder to update FORGEJO_VERSION (cherry picked from commit 2a4d0bd164e55fc981d9437d8220a9c1e00ca59b) (cherry picked from commit d68576ba6762f4af2ed8133fe123fa84c136a90c) [DOCS] CONTRIBUTING: updates * Remove obsolete description of the well being & moderation team and replace them with a link to the moderation email. * Remove description of the governance process and replace with a link to the governance readme that did not exist at the time. * Add links to the Forgejo documentation (cherry picked from commit df749da27225ee13b5e00b689b397b24afebd044) (cherry picked from commit 4da39128c50e5e754f1404a5b79669a8218344be) (cherry picked from commit f442ca6f4032bbd61185e488e5a513f4e4264559) (cherry picked from commit 031928c447e4cbc293de03f6befbba05691810fc) (cherry picked from commit 1e6ba47216f8cab267f555eb488f4e80ef503fcf) (cherry picked from commit 8916a1f8c6358a85c2484a465a73a5d657fcb048) (cherry picked from commit 663e28c41247e98b34cbd6cd32ce1b891f386989) (cherry picked from commit d56b130baaa4dd13bc64f2f149753b7a2e40ae01) [DOCS] CONTRIBUTING (squash) (cherry picked from commit 0dc4b6e5c93e1abc1502149603839ebe30ab4e5a) (cherry picked from commit 52f2163807abc5dcb35ebee32f695368be720105) (cherry picked from commit 47d0ae3e10385b7568474c4f3cae1eb79961838b) (cherry picked from commit 7757a5c34cd61bfc7a96766c6c55baba9d571c3f) (cherry picked from commit 5b4d25bd037d9142fe274bfdeb6ac43cf371ae95) (cherry picked from commit 78798cc25e90200474cb1051f97a97e2d8091568) (cherry picked from commit 3001fb8c7b3eecd6935b3c66f87981d77c0c64d9) (cherry picked from commit da27bf1bc5a3a4ee9b9bcbd34a9d81d503410de8) (cherry picked from commit 2fb13da8ed918fce8cc3a4471aefaba78836ffa5) (cherry picked from commit ea19e0efb33710f36cf2ca300424eca7301922a5) [DOCS] Add link to build instructions in CONTRIBUTING.md (cherry picked from commit 50d86aa4ad740938e6089fc7ebde231653da7f9e) Replace 'v1.20' with 'next' (cherry picked from commit 3e99f49fc5a9c104f2656a330d497c92368994fc) (cherry picked from commit f5c89e88cfe05b4ecc753674a24284b2a2af634c) (cherry picked from commit 8e70433dac072af935676dc42f41b1ef66a0eedd) (cherry picked from commit 31cc99588c0d456beb0b8493f919b06df3782371) fixes 404 links in CONTRIBUTING.md (cherry picked from commit b7326919ab20feaf5650cfb8d284dc074b835e62) (cherry picked from commit cd88e7d177101a9e3be9ef8c19f1220115ae3851) (cherry picked from commit 09d33f2050aafe9ffdd8412b1eacdd8aa172dfd1) (cherry picked from commit 8ea49fc0c7b693ae348738f63a8a6e82fbfeebdc) (cherry picked from commit a434c76f4b30a376643e3716d14bd0514e9af364) (cherry picked from commit c61e1b879717406586ea7c60d5fdea6782637e86) (cherry picked from commit 1ce9dc9defc22837dedfb52f0e8fbf78719204c8) (cherry picked from commit a90927d0b1b57f06625ef53c2860617f67608b92) (cherry picked from commit 17ca38d29a63d691817a09d3c53dc29ce1b8d0e2) (cherry picked from commit 70986dddc958c284a55eca2b8a758d2030a9aebe) (cherry picked from commit 667b4e740734bbb69438021d6813249d65392fb1) (cherry picked from commit dd3a3807780d1125c0b2ab2b47349577ca0073ca) (cherry picked from commit a22b8979e5882a58fcb369408b505d031f491589) (cherry picked from commit 87d1125ad00b0130e5b56f8b303f599f9d8fc6ef) (cherry picked from commit df6ebcc40b742815413741453729cbd3145b3200) (cherry picked from commit 9bac1dbf63c35a40e593e29c7a98e889fce6c3fb) (cherry picked from commit dc5e1998b31c5acf342164f4723c417d4ad5dc14) (cherry picked from commit 4c4878477edb8fa2653b94192a3980062d188140) (cherry picked from commit 9adf97d004f412aeb1e25cf3a63f4509c54b6ba5) (cherry picked from commit 3993bd23c4284766f04c4ace09cc4e92df59cdaa) (cherry picked from commit 1e04d81657005b47cdb11d93006cd174b6b86f2c) --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..2344d371cc --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,24 @@ +# Forgejo Contributor Guide + +The Forgejo project is run by a community of people who are expected to follow this guide when cooperating on a simple bug fix as well as when changing the governance. For more information about the project, take a look at [the documentation explaining what Forgejo provides](README.md). + +Sensitive security-related issues should be reported to [security@forgejo.org](mailto:security@forgejo.org) using [encryption](https://keyoxide.org/security@forgejo.org). + +## For everyone involved + +- [Documentation](https://forgejo.org/docs/next/) +- [Code of Conduct](https://forgejo.org/docs/latest/developer/coc/) +- [Bugs, features, security and others discussions](https://forgejo.org/docs/latest/developer/discussions/) +- [Governance](https://forgejo.org/docs/latest/developer/governance/) +- [Sustainability and funding](https://codeberg.org/forgejo/sustainability/src/branch/main/README.md) + +## For contributors + +- [Developer Certificate of Origin (DCO)](https://forgejo.org/docs/latest/developer/dco/) +- [Development workflow](https://forgejo.org/docs/latest/developer/workflow/) +- [Compiling from source](https://forgejo.org/docs/latest/developer/from-source/) + +## For maintainers + +- [Release management](https://forgejo.org/docs/latest/developer/release/) +- [Secrets](https://forgejo.org/docs/latest/developer/secrets/)