From 64fe34712f456d92109e125d5632b5508518400d Mon Sep 17 00:00:00 2001 From: Otto Richter Date: Sun, 25 Aug 2024 16:15:48 +0000 Subject: [PATCH] Update contributing sections (#821) Rename Developer to Contributor guide - I believe this sounds more inclusive and likely improves the diversity of contributors. Separate translation section clarify external resources Add links to UI/UX and user research repos Separate issue tracker and discussions - I imagine this is part of the confusion for people who report bugs to the discussion tracker. Add welcome section Reviewed-on: https://codeberg.org/forgejo/docs/pulls/821 Reviewed-by: Gusted Co-authored-by: Otto Richter Co-committed-by: Otto Richter --- .../ARCHITECTURE.md | 0 docs/{developer => contributor}/COC.md | 0 docs/{developer => contributor}/DCO.md | 0 .../{developer => contributor}/DISCUSSIONS.md | 0 docs/{developer => contributor}/GOVERNANCE.md | 0 docs/{developer => contributor}/RELEASE.md | 0 docs/{developer => contributor}/SECRETS.md | 0 .../adr/adr-activity-for-like.md | 0 .../adr/adr-ddd-for-federation.md | 0 .../adr/adr-how-to-trigger-activities.md | 0 .../adr/adr-map-federated-person.md | 0 docs/{developer => contributor}/adr/index.md | 0 .../code-forgejo-org.md | 0 .../customization.md | 0 .../dependencies.md | 0 .../development-environment.md | 0 .../federation-architecture.md | 0 .../{developer => contributor}/from-source.md | 0 docs/{developer => contributor}/index.md | 25 +++++---- .../infrastructure.md | 0 .../localization-admin.md | 0 .../localization-english.md | 0 .../localization.md | 0 .../repositories-dependencies.md | 0 .../static-pages.md | 0 docs/{developer => contributor}/testing.md | 0 .../threat-analysis/index.md | 0 .../threat-analysis-like-activity.md | 0 ...hreat-analysis-remote-login-propagation.md | 0 docs/contributor/welcome.md | 52 +++++++++++++++++++ docs/index.md | 2 +- 31 files changed, 69 insertions(+), 10 deletions(-) rename docs/{developer => contributor}/ARCHITECTURE.md (100%) rename docs/{developer => contributor}/COC.md (100%) rename docs/{developer => contributor}/DCO.md (100%) rename docs/{developer => contributor}/DISCUSSIONS.md (100%) rename docs/{developer => contributor}/GOVERNANCE.md (100%) rename docs/{developer => contributor}/RELEASE.md (100%) rename docs/{developer => contributor}/SECRETS.md (100%) rename docs/{developer => contributor}/adr/adr-activity-for-like.md (100%) rename docs/{developer => contributor}/adr/adr-ddd-for-federation.md (100%) rename docs/{developer => contributor}/adr/adr-how-to-trigger-activities.md (100%) rename docs/{developer => contributor}/adr/adr-map-federated-person.md (100%) rename docs/{developer => contributor}/adr/index.md (100%) rename docs/{developer => contributor}/code-forgejo-org.md (100%) rename docs/{developer => contributor}/customization.md (100%) rename docs/{developer => contributor}/dependencies.md (100%) rename docs/{developer => contributor}/development-environment.md (100%) rename docs/{developer => contributor}/federation-architecture.md (100%) rename docs/{developer => contributor}/from-source.md (100%) rename docs/{developer => contributor}/index.md (58%) rename docs/{developer => contributor}/infrastructure.md (100%) rename docs/{developer => contributor}/localization-admin.md (100%) rename docs/{developer => contributor}/localization-english.md (100%) rename docs/{developer => contributor}/localization.md (100%) rename docs/{developer => contributor}/repositories-dependencies.md (100%) rename docs/{developer => contributor}/static-pages.md (100%) rename docs/{developer => contributor}/testing.md (100%) rename docs/{developer => contributor}/threat-analysis/index.md (100%) rename docs/{developer => contributor}/threat-analysis/threat-analysis-like-activity.md (100%) rename docs/{developer => contributor}/threat-analysis/threat-analysis-remote-login-propagation.md (100%) create mode 100644 docs/contributor/welcome.md diff --git a/docs/developer/ARCHITECTURE.md b/docs/contributor/ARCHITECTURE.md similarity index 100% rename from docs/developer/ARCHITECTURE.md rename to docs/contributor/ARCHITECTURE.md diff --git a/docs/developer/COC.md b/docs/contributor/COC.md similarity index 100% rename from docs/developer/COC.md rename to docs/contributor/COC.md diff --git a/docs/developer/DCO.md b/docs/contributor/DCO.md similarity index 100% rename from docs/developer/DCO.md rename to docs/contributor/DCO.md diff --git a/docs/developer/DISCUSSIONS.md b/docs/contributor/DISCUSSIONS.md similarity index 100% rename from docs/developer/DISCUSSIONS.md rename to docs/contributor/DISCUSSIONS.md diff --git a/docs/developer/GOVERNANCE.md b/docs/contributor/GOVERNANCE.md similarity index 100% rename from docs/developer/GOVERNANCE.md rename to docs/contributor/GOVERNANCE.md diff --git a/docs/developer/RELEASE.md b/docs/contributor/RELEASE.md similarity index 100% rename from docs/developer/RELEASE.md rename to docs/contributor/RELEASE.md diff --git a/docs/developer/SECRETS.md b/docs/contributor/SECRETS.md similarity index 100% rename from docs/developer/SECRETS.md rename to docs/contributor/SECRETS.md diff --git a/docs/developer/adr/adr-activity-for-like.md b/docs/contributor/adr/adr-activity-for-like.md similarity index 100% rename from docs/developer/adr/adr-activity-for-like.md rename to docs/contributor/adr/adr-activity-for-like.md diff --git a/docs/developer/adr/adr-ddd-for-federation.md b/docs/contributor/adr/adr-ddd-for-federation.md similarity index 100% rename from docs/developer/adr/adr-ddd-for-federation.md rename to docs/contributor/adr/adr-ddd-for-federation.md diff --git a/docs/developer/adr/adr-how-to-trigger-activities.md b/docs/contributor/adr/adr-how-to-trigger-activities.md similarity index 100% rename from docs/developer/adr/adr-how-to-trigger-activities.md rename to docs/contributor/adr/adr-how-to-trigger-activities.md diff --git a/docs/developer/adr/adr-map-federated-person.md b/docs/contributor/adr/adr-map-federated-person.md similarity index 100% rename from docs/developer/adr/adr-map-federated-person.md rename to docs/contributor/adr/adr-map-federated-person.md diff --git a/docs/developer/adr/index.md b/docs/contributor/adr/index.md similarity index 100% rename from docs/developer/adr/index.md rename to docs/contributor/adr/index.md diff --git a/docs/developer/code-forgejo-org.md b/docs/contributor/code-forgejo-org.md similarity index 100% rename from docs/developer/code-forgejo-org.md rename to docs/contributor/code-forgejo-org.md diff --git a/docs/developer/customization.md b/docs/contributor/customization.md similarity index 100% rename from docs/developer/customization.md rename to docs/contributor/customization.md diff --git a/docs/developer/dependencies.md b/docs/contributor/dependencies.md similarity index 100% rename from docs/developer/dependencies.md rename to docs/contributor/dependencies.md diff --git a/docs/developer/development-environment.md b/docs/contributor/development-environment.md similarity index 100% rename from docs/developer/development-environment.md rename to docs/contributor/development-environment.md diff --git a/docs/developer/federation-architecture.md b/docs/contributor/federation-architecture.md similarity index 100% rename from docs/developer/federation-architecture.md rename to docs/contributor/federation-architecture.md diff --git a/docs/developer/from-source.md b/docs/contributor/from-source.md similarity index 100% rename from docs/developer/from-source.md rename to docs/contributor/from-source.md diff --git a/docs/developer/index.md b/docs/contributor/index.md similarity index 58% rename from docs/developer/index.md rename to docs/contributor/index.md index b7414dbc..a37ecfa7 100644 --- a/docs/developer/index.md +++ b/docs/contributor/index.md @@ -1,16 +1,26 @@ --- -title: 'Forgejo Developer Guide' +title: 'Forgejo Contributor Guide' --- -This area will be targeted to people who want to hack Forgejo and adjust it to +This area is targeted to people who want to improve Forgejo and adjust it to their needs. +We encourage you to [read our warm welcome first](./welcome/), then get involved. + - For everyone involved - [Code of Conduct](./coc/) - - [Bugs, features, security and others discussions](./discussions/) + - [Bugs, enhancement ideas and development roadmap](https://codeberg.org/forgejo/forgejo/issues) + - [General discussions related to Forgejo (tips & tricks, news, ideas, questions)](./discussions/) - [Governance](./governance/) - - [Sustainability and funding](https://codeberg.org/forgejo/sustainability) -- For contributors + - [Sustainability and funding repository](https://codeberg.org/forgejo/sustainability) +- For translators + - [Localization](./localization/) + - [Base localization](./localization-english/) + - [Localization admin duties](./localization-admin/) +- For UI/UX designers and user researchers + - [Design repository](https://codeberg.org/forgejo/design/) + - [User Research repository](https://codeberg.org/forgejo/user-research/) +- For developers - [Compiling from source](./from-source/) - [Testing](./testing/) - [Development environment](./development-environment/) @@ -21,12 +31,9 @@ their needs. - [Threat Analysis](./threat-analysis/) - [Developer Certificate of Origin (DCO)](./dco/) - [code.forgejo.org](./code-forgejo-org/) - - [next.forgejo.org](https://code.forgejo.org/infrastructure/k8s) + - [next.forgejo.org kubernetes infrastructure](https://code.forgejo.org/infrastructure/k8s) - [static pages](./static-pages/) - [Forgejo runner implementation notes](https://code.forgejo.org/forgejo/runner/#hacking) - - [Localization](./localization/) - - [Base localization](./localization-english/) - - [Localization admin duties](./localization-admin/) - [Dependency management](./dependencies/) - For maintainers - [Hardware infrastructure](./infrastructure/) diff --git a/docs/developer/infrastructure.md b/docs/contributor/infrastructure.md similarity index 100% rename from docs/developer/infrastructure.md rename to docs/contributor/infrastructure.md diff --git a/docs/developer/localization-admin.md b/docs/contributor/localization-admin.md similarity index 100% rename from docs/developer/localization-admin.md rename to docs/contributor/localization-admin.md diff --git a/docs/developer/localization-english.md b/docs/contributor/localization-english.md similarity index 100% rename from docs/developer/localization-english.md rename to docs/contributor/localization-english.md diff --git a/docs/developer/localization.md b/docs/contributor/localization.md similarity index 100% rename from docs/developer/localization.md rename to docs/contributor/localization.md diff --git a/docs/developer/repositories-dependencies.md b/docs/contributor/repositories-dependencies.md similarity index 100% rename from docs/developer/repositories-dependencies.md rename to docs/contributor/repositories-dependencies.md diff --git a/docs/developer/static-pages.md b/docs/contributor/static-pages.md similarity index 100% rename from docs/developer/static-pages.md rename to docs/contributor/static-pages.md diff --git a/docs/developer/testing.md b/docs/contributor/testing.md similarity index 100% rename from docs/developer/testing.md rename to docs/contributor/testing.md diff --git a/docs/developer/threat-analysis/index.md b/docs/contributor/threat-analysis/index.md similarity index 100% rename from docs/developer/threat-analysis/index.md rename to docs/contributor/threat-analysis/index.md diff --git a/docs/developer/threat-analysis/threat-analysis-like-activity.md b/docs/contributor/threat-analysis/threat-analysis-like-activity.md similarity index 100% rename from docs/developer/threat-analysis/threat-analysis-like-activity.md rename to docs/contributor/threat-analysis/threat-analysis-like-activity.md diff --git a/docs/developer/threat-analysis/threat-analysis-remote-login-propagation.md b/docs/contributor/threat-analysis/threat-analysis-remote-login-propagation.md similarity index 100% rename from docs/developer/threat-analysis/threat-analysis-remote-login-propagation.md rename to docs/contributor/threat-analysis/threat-analysis-remote-login-propagation.md diff --git a/docs/contributor/welcome.md b/docs/contributor/welcome.md new file mode 100644 index 00000000..a142270a --- /dev/null +++ b/docs/contributor/welcome.md @@ -0,0 +1,52 @@ +--- +title: 'Welcome to Forgejo' +license: 'CC-BY-SA-4.0' +--- + +Welcome to our project! We are looking forward to seeing you participate in our community. +Thank you so much for improving Forgejo within your means. + +Forgejo consists of a diverse community, +and so far we have found a place for everyone and their unique skills, +no matter if they are in communication, management or technical. + +Forgejo contributors are very motivated and aim at a very high software quality, +and we hope you'll find yourself inspired by the spirit in our community. +The standards might feel surprisingly high if you compare to some other free software projects of similar size. +Try to bring some patience and consider starting with small contributions to get used to the workflow. +Don't be afraid: We are here to help you in any situation, +and there are low-hanging fruits and easy tasks to get started with. + +Some examples you might be surprised about: + +- We perform [user research](https://codeberg.org/forgejo/user-research) and user testing. +- We try to apply a [design workflow](https://codeberg.org/forgejo/design/) prior to implementing feature requests (read about the [background](https://codeberg.org/forgejo/discussions/issues/178)). +- To reduce the long-term maintenance effort, we require that code changes bring a significant amount of testing. +- Changes can undergo a lot of review and iterations (not only code but also documentation, translations etc). + +## Getting Started + +We recommend to join the Matrix channels (see link in footer) and say hi. +The chats are very active and a good place to ask for help or get to know the community. + +Depending on where you want to get involved with, check the [list of resources](../). +There might be subjects with less or incomplete onboarding information. +Don't hesitate to say hi and ask for more information, +especially if you want to contribute in a domain that has no clear getting-started procedure +(e.g. helping with project communication / socializing). + +If you want to start developing for Forgejo, +we recommend you take a look at [good first issues](https://codeberg.org/forgejo/forgejo/issues/?labels=222666). +In the conversation, you will typically find some information about where to start and what is expected in the change. +Don't hesitate to reply to the issue, explain you'd like to get started or ask questions if any. +The maintainer who added the "good first issue" label will be happy to assist you on your way. + +## Getting into the project + +If you have fun contributing to Forgejo, +we invite you to consider yourself a part of the community. +Hang around in the chats, have fun with others and feel free to share your feedback, even on things you didn't yet contribute to. +We recommend you make yourself familiar with our [governance repository](https://codeberg.org/forgejo/governance) +and watch the activity for decisions you might want to participate in. +[Check out the teams](https://codeberg.org/forgejo/governance/src/branch/main/TEAMS.md) +and consider applying to those who match your interests. diff --git a/docs/index.md b/docs/index.md index 29d2084b..b9aa44ba 100644 --- a/docs/index.md +++ b/docs/index.md @@ -7,5 +7,5 @@ title: 'Forgejo prerelease documentation' - [FAQ](/faq/) - [Administrator guide](./admin/) - [User guide](./user/) -- [Developer guide](./developer/) +- [Contributor guide](./contributor/) - [License](./license/)