0
0
Fork 0
mirror of https://codeberg.org/forgejo/docs.git synced 2024-11-20 17:26:56 -05:00

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 <gusted@noreply.codeberg.org>
Co-authored-by: Otto Richter <git@otto.splvs.net>
Co-committed-by: Otto Richter <git@otto.splvs.net>
This commit is contained in:
Otto Richter 2024-08-25 16:15:48 +00:00 committed by Otto
parent 3de284c2c9
commit 64fe34712f
31 changed files with 69 additions and 10 deletions

View file

@ -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. their needs.
We encourage you to [read our warm welcome first](./welcome/), then get involved.
- For everyone involved - For everyone involved
- [Code of Conduct](./coc/) - [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/) - [Governance](./governance/)
- [Sustainability and funding](https://codeberg.org/forgejo/sustainability) - [Sustainability and funding repository](https://codeberg.org/forgejo/sustainability)
- For contributors - 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/) - [Compiling from source](./from-source/)
- [Testing](./testing/) - [Testing](./testing/)
- [Development environment](./development-environment/) - [Development environment](./development-environment/)
@ -21,12 +31,9 @@ their needs.
- [Threat Analysis](./threat-analysis/) - [Threat Analysis](./threat-analysis/)
- [Developer Certificate of Origin (DCO)](./dco/) - [Developer Certificate of Origin (DCO)](./dco/)
- [code.forgejo.org](./code-forgejo-org/) - [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/) - [static pages](./static-pages/)
- [Forgejo runner implementation notes](https://code.forgejo.org/forgejo/runner/#hacking) - [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/) - [Dependency management](./dependencies/)
- For maintainers - For maintainers
- [Hardware infrastructure](./infrastructure/) - [Hardware infrastructure](./infrastructure/)

View file

@ -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.

View file

@ -7,5 +7,5 @@ title: 'Forgejo prerelease documentation'
- [FAQ](/faq/) - [FAQ](/faq/)
- [Administrator guide](./admin/) - [Administrator guide](./admin/)
- [User guide](./user/) - [User guide](./user/)
- [Developer guide](./developer/) - [Contributor guide](./contributor/)
- [License](./license/) - [License](./license/)