Skip to content

Commit 61e2a8d

Browse files
RichiHRichiH
committedSep 4, 2023
Add project structure
Signed-off-by: Richard Hartmann <richih@richih.org>
·
v2.0.7beyla-1.0.0
1 parent 781c005 commit 61e2a8d

File tree

3 files changed

+213
-0
lines changed

3 files changed

+213
-0
lines changed
 

‎CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at conduct@grafana.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

‎GOVERNANCE.md

+156
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
---
2+
title: Governance
3+
---
4+
5+
# Governance
6+
7+
This document describes the rules and governance of the project. It is meant to be followed by all the developers of the project and the Beyla community. Common terminology used in this governance document are listed below:
8+
9+
- **Team members**: Any members of the private [team mailing list][team].
10+
11+
- **Maintainers**: Maintainers lead an individual project or parts thereof ([`MAINTAINERS.md`][maintainers]).
12+
13+
- **Projects**: A single repository in the Grafana GitHub organization and listed below is referred to as a project:
14+
15+
- Beyla
16+
17+
- **The Beyla project**: The sum of all activities performed under this governance, concerning one or more repositories or the community.
18+
19+
## Values
20+
21+
The Beyla developers and community are expected to follow the values defined in the [Code of Conduct][coc]. Furthermore, the Beyla community strives for kindness, giving feedback effectively, and building a welcoming environment. The Beyla developers generally decide by consensus and only resort to conflict resolution by a majority vote if consensus cannot be reached.
22+
23+
## Projects
24+
25+
Each project must have a [`MAINTAINERS.md`][maintainers] file with at least one maintainer. Where a project has a release process, access and documentation should be such that more than one person can perform a release. Releases should be announced on the [announcemount][announce] and [users][users] mailing lists. Any new projects should be first proposed on the [team mailing list][team] following the voting procedures listed below.
26+
27+
## Decision making
28+
29+
### Team members
30+
31+
Team member status may be given to those who have made ongoing contributions to the Beyla project for at least 3 months. This is usually in the form of code improvements and/or notable work on documentation, but organizing events or user support could also be taken into account.
32+
33+
New members may be proposed by any existing member by email to the [team mailing list][team]. It is highly desirable to reach consensus about acceptance of a new member. However, the proposal is ultimately voted on by a formal [supermajority vote](#supermajority-vote).
34+
35+
If the new member proposal is accepted, the proposed team member should be contacted privately via email to confirm or deny their acceptance of team membership. This email will also be CC'd to the [team mailing list][team] for record-keeping purposes.
36+
37+
If they choose to accept, the [onboarding](#onboarding) procedure is followed.
38+
39+
Team members may retire at any time by emailing [the team][team].
40+
41+
Team members can be removed by [supermajority vote](#supermajority-vote) on [the team mailing list][team].
42+
For this vote, the member in question is not eligible to vote and does not count towards the quorum.
43+
Any removal vote can cover only one single person.
44+
45+
Upon death of a member, they leave the team automatically.
46+
47+
In case a member leaves, the [offboarding](#offboarding) procedure is applied.
48+
49+
The current team members are:
50+
51+
- Mario Macías - [@mariomac](https://github.com/mariomac) ([Grafana Labs](https://grafana.com/))
52+
- Matt Frick - [@MattFrick](https://github.com/MattFrick) ([Grafana Labs](https://grafana.com/))
53+
- Nikola Grcevski - [@grcevski](https://github.com/grcevski) ([Grafana Labs](https://grafana.com/))
54+
55+
### Maintainers
56+
57+
Maintainers lead one or more project(s) or parts thereof and serve as a point of conflict resolution amongst the contributors to this project. Ideally, maintainers are also team members, but exceptions are possible for suitable maintainers that, for whatever reason, are not yet team members.
58+
59+
Changes in maintainership have to be announced on the [developers mailing list][devs]. They are decided by [rough consensus](#consensus) and formalized by changing the [`MAINTAINERS.md`][maintainers] file of the respective repository.
60+
61+
Maintainers are granted commit rights to all projects covered by this governance.
62+
63+
A maintainer or committer may resign by notifying the [team mailing list][team]. A maintainer with no project activity for a year is considered to have resigned. Maintainers that wish to resign are encouraged to propose another team member to take over the project.
64+
65+
A project may have multiple maintainers, as long as the responsibilities are clearly agreed upon between them. This includes coordinating who handles which issues and pull requests.
66+
67+
### Technical decisions
68+
69+
Technical decisions that only affect a single project are made informally by the maintainer of this project, and [rough consensus](#consensus) is assumed. Technical decisions that span multiple parts of the project should be discussed and made on the [developer mailing list][devs].
70+
71+
Decisions are usually made by [rough consensus](#consensus). If no consensus can be reached, the matter may be resolved by [majority vote](#majority-vote).
72+
73+
### Governance changes
74+
75+
Changes to this document are made by Grafana Labs.
76+
77+
### Other matters
78+
79+
Any matter that needs a decision may be called to a vote by any member if they deem it necessary. For private or personnel matters, discussion and voting takes place on the [team mailing list][team], otherwise on the [developer mailing list][devs].
80+
81+
## Voting
82+
83+
The Beyla project usually runs by informal consensus, however sometimes a formal decision must be made.
84+
85+
Depending on the subject matter, as laid out [above](#decision-making), different methods of voting are used.
86+
87+
For all votes, voting must be open for at least one week. The end date should be clearly stated in the call to vote. A vote may be called and closed early if enough votes have come in one way so that further votes cannot change the final decision.
88+
89+
In all cases, all and only [team members](#team-members) are eligible to vote, with the sole exception of the forced removal of a team member, in which said member is not eligible to vote.
90+
91+
Discussion and votes on personnel matters (including but not limited to team membership and maintainership) are held in private on the [team mailing list][team]. All other discussion and votes are held in public on the [developer mailing list][devs].
92+
93+
For public discussions, anyone interested is encouraged to participate. Formal power to object or vote is limited to [team members](#team-members).
94+
95+
### Consensus
96+
97+
The default decision making mechanism for the Beyla project is [rough][rough] consensus. This means that any decision on technical issues is considered supported by the [team][team] as long as nobody objects or the objection has been considered but not necessarily accommodated.
98+
99+
Silence on any consensus decision is implicit agreement and equivalent to explicit agreement. Explicit agreement may be stated at will. Decisions may, but do not need to be called out and put up for decision on the [developers mailing list][devs] at any time and by anyone.
100+
101+
Consensus decisions can never override or go against the spirit of an earlier explicit vote.
102+
103+
If any [team member](#team-members) raises objections, the team members work together towards a solution that all involved can accept. This solution is again subject to rough consensus.
104+
105+
In case no consensus can be found, but a decision one way or the other must be made, any [team member](#team-members) may call a formal [majority vote](#majority-vote).
106+
107+
### Majority vote
108+
109+
Majority votes must be called explicitly in a separate thread on the appropriate mailing list. The subject must be prefixed with `[VOTE]`. In the body, the call to vote must state the proposal being voted on. It should reference any discussion leading up to this point.
110+
111+
Votes may take the form of a single proposal, with the option to vote yes or no, or the form of multiple alternatives.
112+
113+
A vote on a single proposal is considered successful if more vote in favor than against.
114+
115+
If there are multiple alternatives, members may vote for one or more alternatives, or vote “no” to object to all alternatives. It is not possible to cast an “abstain” vote. A vote on multiple alternatives is considered decided in favor of one alternative if it has received the most votes in favor, and a vote from more than half of those voting. Should no alternative reach this quorum, another vote on a reduced number of options may be called separately.
116+
117+
### Supermajority vote
118+
119+
Supermajority votes must be called explicitly in a separate thread on the appropriate mailing list. The subject must be prefixed with `[VOTE]`. In the body, the call to vote must state the proposal being voted on. It should reference any discussion leading up to this point.
120+
121+
Votes may take the form of a single proposal, with the option to vote yes or no, or the form of multiple alternatives.
122+
123+
A vote on a single proposal is considered successful if at least two thirds of those eligible to vote vote in favor.
124+
125+
If there are multiple alternatives, members may vote for one or more alternatives, or vote “no” to object to all alternatives. A vote on multiple alternatives is considered decided in favor of one alternative if it has received the most votes in favor, and a vote from at least two thirds of those eligible to vote. Should no alternative reach this quorum, another vote on a reduced number of options may be called separately.
126+
127+
## On- / Offboarding
128+
129+
### Onboarding
130+
131+
The new member is
132+
133+
- added to the list of [team members](#team-members). Ideally by sending a PR of their own, at least approving said PR.
134+
- announced on the [developers mailing list][devs] by an existing team member. Ideally, the new member replies in this thread, acknowledging team membership.
135+
- added to the projects with commit rights.
136+
- added to the [team mailing list][team].
137+
138+
### Offboarding
139+
140+
The ex-member is
141+
142+
- removed from the list of [team members](#team-members). Ideally by sending a PR of their own, at least approving said PR. In case of forced removal, no approval is needed.
143+
- removed from the projects. Optionally, they can retain maintainership of one or more repositories if the [team](#team-members) agrees.
144+
- removed from the team mailing list and demoted to a normal member of the other mailing lists.
145+
- not allowed to call themselves an active team member any more, nor allowed to imply this to be the case.
146+
- added to a list of previous members if they so choose.
147+
148+
If needed, we reserve the right to publicly announce removal.
149+
150+
[announce]: https://github.com/grafana/beyla/discussions/categories/announcements
151+
[coc]: https://github.com/grafana/beyla/blob/master/CODE_OF_CONDUCT.md
152+
[devs]: https://github.com/grafana/beyla/discussions/categories/development
153+
[maintainers]: https://github.com/grafana/beyla/blob/master/MAINTAINERS.md
154+
[rough]: https://tools.ietf.org/html/rfc7282
155+
[team]: https://groups.google.com/g/beyla-team
156+
[users]: https://github.com/grafana/beyla/discussions

‎MAINTAINERS.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
The following are the main/default maintainers:
2+
3+
- Mario Macías - [@mariomac](https://github.com/mariomac) ([Grafana Labs](https://grafana.com/))
4+
- Matt Frick - [@MattFrick](https://github.com/MattFrick) ([Grafana Labs](https://grafana.com/))
5+
- Nikola Grcevski - [@grcevski](https://github.com/grcevski) ([Grafana Labs](https://grafana.com/))
6+
7+
Some parts of the codebase have other maintainers, the package paths also include all sub-packages:
8+
9+
- `docs`:
10+
- Jack Baldry — [@jdbaldry](https://github.com/jdbaldry) ([Grafana Labs](https://grafana.com/))
11+
- Sean Packham — [@grafsean](https://github.com/grafsean) ([Grafana Labs](https://grafana.com/))

0 commit comments

Comments
 (0)
Please sign in to comment.