baalajimaestro/traefik
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Adding Maintainers Guidelines

Browse source
This commit is contained in:
Jakub Hajek 2021-06-02 18:02:06 +02:00 committed by GitHub
parent 1680f00091
commit c10c7619d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 88 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CONTRIBUTING.md
View file

@ -1,4 +1,9 @@
# Contributing # Contributing
- https://doc.traefik.io/traefik/contributing/submitting-pull-requests/ Here are some guidelines that should help to start contributing to the project.
- https://doc.traefik.io/traefik/contributing/submitting-issues/
- [Submitting pull Requests](https://github.com/traefik/contributors-guide/blob/master/pr_guidelines.md)
- [Submitting issues](https://doc.traefik.io/traefik/contributing/submitting-issues/)
- [Submitting security issues](docs/content/contributing/submitting-security-issues.md)
If you are willing to become a maintainer of the project, please take a look at the [maintainers guidelines](docs/content/contributing/maintainers-guidelines.md).

5
README.md
View file

@ -126,7 +126,10 @@ You can find high level and deep dive videos on [videos.traefik.io](https://vide
## Maintainers ## Maintainers
[Information about process and maintainers](docs/content/contributing/maintainers.md) We are strongly promoting a philosophy of openness and sharing, and firmly standing against the elitist closed approach. Being part of the core team should be accessible to anyone who is motivated and want to be part of that journey!
This [document](docs/content/contributing/maintainers-guidelines.md) describes how to be part of the core team as well as various responsibilities and guidelines for Traefik maintainers.
You can also find more information on our process to review pull requests and manage issues [in this document](docs/content/contributing/maintainers.md).
## Contributing ## Contributing

BIN
docs/content/assets/img/maintainers-guidelines.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 966 KiB

73
docs/content/contributing/maintainers-guidelines.md Normal file
View file

@ -0,0 +1,73 @@
<p align="center">
<img src="../../assets/img/maintainers-guidelines.png" alt="Traefik Maintainer's Guidelines" title="Maintainer's Guidelines" />
</p>
# The Maintainers Guidelines
Note: the document is a work in progress.
Welcome to the Traefik Community. This document describes how to be part of the core team as well as various responsibilities and guidelines for Traefik maintainers. We are strongly promoting a philosophy of openness and sharing, and firmly standing against the elitist closed approach. Being part of the core team should be accessible to anyone who is motivated and want to be part of that journey!
## Onboarding process
If you consider joining our community please drop us a line using Twitter or leave a note in the issue. We will schedule a quick call in order to meet you and learn more about your motivation. During the call the team will discuss the process of becoming a maintainer. We will be happy to answer any questions and explain all your doubts.
## Maintainers requirements
Note: you do not have to meet all of the listed requirements, but must have achieved several.
- Enabled [2FA](https://docs.github.com/en/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication) on your Github account
- The contributor has opened and successfully run medium to large PR’s in the past 6 months.
- The contributor has participated in multiple code reviews of other PR’s, including those of other maintainers and contributors.
- The contributor showed a consistent pattern of helpful, non-threatening, and friendly behaviour towards other community members in the past.
- The contributor is active on Traefik Community forums or other technical forums / boards such as K8S slack, Reddit, StackOverflow, hacker news.
- Have read and accepted the contributor guidelines.
## Maintainers responsibilities and privileges
There are lots of areas where you can contribute to the project but we can suggest you start with activities such as:
- PR reviewing.
- According to our guidelines we require you have at least 3 reviewers, thus you can review a PR and leave the relevant comment if it is necessary.
- Participating in a daily [issue triage](https://github.com/traefik/contributors-guide/blob/master/issue_triage.md).
- The process helps to understand and prioritize the reported issue according to its importance and severity. This is crucial in order to learn how our users implement Traefik. Each of the issues that are labeled as bug/possible bug/confirmed requires a reproducible use case. You can help in creating a reproducible use case if it has not been added to the issue or use the sample code provided by the reporter. Typically, a simple docker compose should be enough to reproduce the issue.
- Code contribution.
- Documentation contribution.
- Technical documentation is one of the most important components of the product. The ability to set up a testing environment using Traefik in a few minutes using the official documentation is a game changer.
- You will be listed on our Maintainers Github page as well as on our website in the section [maintainers](maintainers.md).
- We will be promoting you in social channels (mostly on Twitter).
## Governance
- Roadmap meetings on a regular basis where all maintainers are welcome.
## Communicating
- All of our maintainers are added to Slack #traefik-maintainers channel that belongs to Traefik labs workspace. Having the team in one place helps us to communicate effectively. You can reach Traefik core developers directly, which offers the possibility to discuss issues, pull requests, enhancements more efficiently and get the feedback almost immediately. Fewer blockers mean more fun and engaging work.
- We publish a report to the channel on a daily basis that includes all the activities performed during the day. You are updated in regards to the workload that has been processed including: working on the new features and enhancements, activities related to the reported issues and PR’s, other important project-related announcements.
- At 5:00 PM CET every day we review all the created issues that have been reported, assign the specific *[labels](maintainers.md#labels)* and prioritize them based on the severity of the problem. The process is called *[issue triaging](https://github.com/traefik/contributors-guide/blob/master/issue_triage.md).* Each of the maintainers is welcome to join the meeting. For that purpose, we use a dedicated Discord server where you are invited once you have become the official maintainer.
## Maintainers Activity
In order to keep the core team efficient and dynamic, maintainers activity and involvement will be reviewed on a regular basis.
- Has the maintainer engaged with the team and the community by meeting two or more of these benchmarks in the past six months?
- Has the maintainer participated in at least two or three maintainer meetings?
- Substantial review of at least one or two PRs from either contributors or maintainers.
- Opened at least one or two bug fixes or feature request PRs that were eventually merged (or on a trajectory for merge).
- Substantial participation in the Help Wanted program (answered questions, helped identify issues, applied guidelines from the Help Wanted guide to open issues).
- Substantial participation with the community in general.
- Has the maintainer shown a consistent pattern of helpful, non-threatening, and friendly behavior towards other people on the maintainer team and with our community?
## Additional comments for (not only) maintainers
- Be able to put yourself in users’ shoes.
- Be open-minded and respectful with other maintainers and other community members.
- Keep the communication public - if anyone tries to communicate with you directly, ask him politely to move the conversation to a public communication channel.
- Stay away from defensive comments.
- Please try to express your thoughts clearly enough and note that some of us are not native English speakers. Try to rephrase your sentences, avoiding mental shortcuts; none of us is able to predict your thoughts.
- There are a lot of use cases of using Traefik and even more issues that are difficult to reproduce. If the issue can’t be replicated due to a lack of reproducible case (a simple docker compose should be enough) - set your own time limits while working on the issue and express it clearly that you were not able to replicate it. You can come back later to that case.
- Be proactive.
- Emoji are fine, but if you express yourself clearly enough they are not necessary. They will not replace good communication.
- Embrace mentorship.
- Keep in mind that we all have the same intent to improve the project.

4
docs/content/contributing/maintainers.md
View file

@ -20,6 +20,10 @@
* Kevin Pollet [@kevinpollet](https://github.com/kevinpollet) * Kevin Pollet [@kevinpollet](https://github.com/kevinpollet)
* Harold Ozouf [@jspdown](https://github.com/jspdown) * Harold Ozouf [@jspdown](https://github.com/jspdown)
## Maintainers guidelines
Please read the [maintainers guidelines](maintainers-guidelines.md)
## Issue Triage ## Issue Triage
Issues and PRs are triaged daily and the process for triaging may be found under [triaging issues](https://github.com/traefik/contributors-guide/blob/master/issue_triage.md) in our [contributors guide repository](https://github.com/traefik/contributors-guide). Issues and PRs are triaged daily and the process for triaging may be found under [triaging issues](https://github.com/traefik/contributors-guide/blob/master/issue_triage.md) in our [contributors guide repository](https://github.com/traefik/contributors-guide).