- Markdown 100%
Otto Richter
fc476f6bc6
New approach for the introduction - reduce static information in the README and reference the issues instead - try to make reading more actionable and guide through first steps - update some outdated information Draft guidelines Reviewed-on: Codeberg/Contributing#46 Co-authored-by: Otto Richter <git@otto.splvs.net> Co-committed-by: Otto Richter <git@otto.splvs.net> |
||
|---|---|---|
| ISSUE_TEMPLATE | ||
| GUIDELINES.md | ||
| LICENSE | ||
| README.md | ||
Table of Contents
Contributing to Codeberg 🩵
Do you want to get involved in Codeberg? Thank you so much! Read on to learn how you can help.
Getting Started
Are you on Matrix yet? It's a federated Free Messenger: Choose a server and client you like (think of E-Mail for Chats or XMPP for the mainstream). Most communication among our contributors is on Matrix, and you'll likely find it easier to get quick help if you join the Contributing to Matrix room
Feel free to present yourself via an issue in this repo. It will help us know about your skills and interest and match you with a task.
Participating in smalltalk helps you get to know other people. Maybe you find people with similar interest and commit yourself to working on something together.
Finding interesting work
Browse the open issues here and check if a team interests you. The labels help you check the priority and whether you can join an existing effort, or bootstrap a new team. Further information can be found in the issue. If something is unclear, don't be shy and add a comment asking for more information.
If you didn't find something that matches your interests, please let us know if you have ideas on your own. Codeberg's community maintenance allows you to work on things you are interested in. Maybe it's a cool idea we didn't think about before.
Inexperienced? Don't worry!
Many people feel like they cannot keep pace with an organization of the size of Codeberg. But it's actually the opposite: Codeberg is what it is due to the diverse nature of our contributors. We are sure there is a place for you!
Codeberg does not only need Designers, User Experience experts, frontend and backend developers, system administrators and communication managers. We also need people who can help us connect the domains by bringing in new perspectives.
For some of our current core team members, Codeberg was also a great learning opportunity. It allowed them to dive into topics they were interested in, and make rapid experiences therein. If you want to learn, please get in touch and we'll try to ensure you'll find a productive environment to extend your skills.
Get help when you are stuck
Take a break from what you are doing and get your head free. Then try to organize your thoughts, break your problem down, and chat with others about the problem (for example in the Matrix room or in your issue).
If this doesn't help you, or you have dependencies (hardware, permissions etc) or you can't figure out how to continue, you can usually ping one of these people:
They can help you figure out where to continue.
Start a new project
Something is missing? You want to help? Great! If there is no issue yet, propose a new team in the issue tracker. Explain that you want to take the lead.
To prevent projects from going stale once a person loses interest or other circumstances prevent them from continuing their work, we usually want to have at least two maintainers. Please help us in finding a second person for your project by actively asking for help in the issue and chatrooms.
Some of our projects
You can find more teams in the issue tracker. This list adds a few information about the most relevant teams.
Active Software Projects
| Name | Looking for help? | Contact | Stack | Comment |
|---|---|---|---|---|
| Forgejo | Always welcome | #forgejo-development:matrix.org | Go, CSS, JavaScript | |
| Codeberg Pages | Yes! | #gitea-pages-server:matrix.org | Go | Looking for a challenge? Help us tackle stability issues! |
| Registration Server | There's always room for improvement. | Issue Tracker, @momar, @f0sh | Go, HTML | Please check the hackathon branch |
Community Projects
These projects do not necessarily require coding experience, but benefit from other things like community management, writing or Public Relations Experience.
| Name | Status | Contact | Skills | Comment |
|---|---|---|---|---|
| Documentation | help welcome | Issue Tracker, #codeberg-documentation:matrix.org at Matrix | Writing, Spellchecking or JavaScript / Static Site Generators | |
| Community Issue Tracker Maintenance | More help welcome | Issue Tracker or Contributing to Codeberg Matrix Channel | nothing special | Maintaining the public issue tracker and forwarding reports as appropriate. |
| Event Calendar | Needs more events | Contributing to Codeberg Matrix Channel | Organizing | We are looking for people to organize regular (monthly / bi-weekly) meetings |
| Matrix Spaces | ok | @6543, @Bubu | nothing special | Moderation and Maintenance of Channels |
Infrastructure Projects
Some of these require certain access levels to Codeberg's infrastructure. If you are interested and commit a certain amount of time, this can surely be talked about. Please see the "Limitations" sections.
In case of upstream projects, maintaining the service also includes collecting and forwarding bug reports to upstream development.
Many of the scripts that we use to host Codeberg can be found in a specially designated organization.
| Name | Status | Contact | Requirements | Comment |
|---|---|---|---|---|
| Codeberg Pages | Needs maintainers | Repository | Some call to build trust | |
| Weblate | Co-maintainers welcome | Matrix: #codeberg-translate:bubu1.eu | Some call to build trust | |
| Continuous Integration | Co-maintainers very welcome | Matrix: #codeberg-ci:obermui.de | Some call to build trust, maybe some LXC/Docker experience | |
| Code Search | @fourstepper, @yoctozepto are experimenting with potential solutions, help still appreciated | Repository and Matrix: #codeberg-code-search:matrix.org | Experience with related tech stacks (see Codeberg/Community#904), trust-building | If you have any experience with code search and would like to participate in the team, please do get in touch! |
| Status Page / Monitoring | Co-maintainers and innovations welcome | ? | Some call to build trust | |
| Forgejo ("Codeberg.org") | OK, but contributions welcome | Repository | Access to production machines limited to very trustworthy people | Suggestions (e.g. config improvements, new features etc) and some assistance when investigating issues welcome |
| Hardware, Ceph, MariaDB | Experience welcome | Skillsharing here | Access to production machines limited to very trustworthy people | Feel free to work with us on specific issues, and become a regular maintainer over time |