You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Subject Matter Experts and new Bevy Org docs (bevyengine#7185)
We are in the process of rolling out a new Bevy Organization role! (Subject Matter Expert)
This adds a new "The Bevy Organization" document and links to it from CONTRIBUTING.md. This doc describes how the Bevy Organization will work going forward. It outlines the functionality of each role, as well as the expectations we have for them. The previously existing roles (Project Lead, Maintainer) still work the same way, but their definition and scope have been made much clearer.
Tomorrow we will be announcing this publicly in a blog post. This will describe the motivation and announce the first round of SMEs . But before that it makes sense to do a quick review round first.
Given the quick turnaround on this PR, this isn't the best platform to discuss changes to the SME system (or its validity). After you have read the announcement tomorrow, feel free to start discussions wherever is preferable to you (this repo, discord, etc). So for now, please just review for clarity / typos / phrasing / missed info / etc.
[Rendered](https://github.com/bevyengine/bevy/blob/08ceae43dbfacf630447e5f5f1cfa53397242687/docs/the_bevy_organization.md)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+19-47Lines changed: 19 additions & 47 deletions
Original file line number
Diff line number
Diff line change
@@ -50,7 +50,7 @@ Bevy is a completely free and open source game engine built in Rust. It currentl
50
50
Bevy also currently has the following "development process" goals:
51
51
52
52
***Rapid experimentation over API stability**: We need the freedom to experiment and iterate in order to build the best engine we can. This will change over time as APIs prove their staying power.
53
-
***Consistent vision**: The engine needs to feel consistent and cohesive. This takes precedent over democratic and/or decentralized processes. See [*How we're organized*](#how-were-organized) for more details.
53
+
***Consistent vision**: The engine needs to feel consistent and cohesive. This takes precedent over democratic and/or decentralized processes. See our [*Bevy Organization doc*](/docs/the_bevy_organization.md) for more details.
54
54
***Flexibility over bureaucracy**: Developers should feel productive and unencumbered by development processes.
55
55
***Focus**: The Bevy Org should focus on building a small number of features excellently over merging every new community-contributed feature quickly. Sometimes this means pull requests will sit unmerged for a long time. This is the price of focus and we are willing to pay it. Fortunately Bevy is modular to its core. 3rd party plugins are a great way to work around this policy.
56
56
***User-facing API ergonomics come first**: Solid user experience should receive significant focus and investment. It should rarely be compromised in the interest of internal implementation details.
@@ -66,41 +66,19 @@ Bevy also currently has the following "development process" goals:
66
66
* Most new features should have at least one minimal [example](https://github.com/bevyengine/bevy/tree/main/examples). These also serve as simple integration tests, as they are run as part of our CI process.
67
67
* The more complex or "core" a feature is, the more strict we are about unit tests. Use your best judgement here. We will let you know if your pull request needs more tests. We use [Rust's built in testing framework](https://doc.rust-lang.org/book/ch11-01-writing-tests.html).
68
68
69
-
## How we're organized
69
+
## The Bevy Organization
70
70
71
-
@cart is, for now, our singular Benevolent Dictator and project lead.
72
-
He makes the final decision on both design and code changes within Bevy in order to ensure a coherent vision and consistent quality of code.
71
+
The Bevy Organization is the group of people responsible for stewarding the Bevy project. It handles things like merging pull requests, choosing project direction, managing bugs / issues / feature requests, running the Bevy website, controlling access to secrets, defining and enforcing best practices, etc.
73
72
74
-
In practice, @cart serves as a shockingly accountable dictator: open to new ideas and to changing his mind in the face of compelling arguments or community consensus.
75
-
Check out the next section for details on how this plays out.
73
+
Note that you *do not* need to be a member of the Bevy Organization to contribute to Bevy. Community contributors (this means you) can freely open issues, submit pull requests, and review pull requests.
76
74
77
-
[Bevy Org members](https://github.com/orgs/bevyengine/people) are contributors who:
78
-
79
-
1. Have actively engaged with Bevy development.
80
-
2. Have demonstrated themselves to be polite and welcoming representatives of the project with an understanding of our goals and direction.
81
-
3. Have asked to join the Bevy Org. Reach out to @cart on [Discord] or email us at [email protected] if you are interested. Everyone is welcome to do this. We generally accept membership requests, so don't hesitate if you are interested!
82
-
83
-
All Bevy Org members are also Triage Team members. These people can label and close issues and PRs but do not have merge rights or any special authority within the community.
84
-
85
-
Merge rights within the org are relatively centralized: this requires a large amount of trust when it comes to ethics, technical ability, and ability to enforce consistent project direction.
86
-
87
-
The current structure is as follows:
88
-
89
-
*@cart is our project lead, and has final say on controversial decisions
90
-
* There is a small group of other maintainers (@alice-i-cecile, @mockersf and @superdump), who have merge rights but abide by the following rules:
91
-
* Trivial PRs can be merged without approvals.
92
-
* Relatively uncontroversial PRs can be merged following approval from at least two other community members with appropriate expertise.
93
-
* Controversial PRs are added to a backlog for @cart to address once two maintainers agree that they are ready.
94
-
* If 45 days elapse without action on a controversial PR (approval, feedback or an explicit request to defer), they can be merged without project lead approval.
95
-
* The Bevy org is made up of trusted community contributors: this is a relatively low bar, and org members help triage and maintain the project.
96
-
* Community contributors (this means you!) can freely open issues, submit PRs and review PRs to improve Bevy.
97
-
* As discussed above, community reviews on PRs are incredibly helpful to enable maintainers to merge in uncontroversial PRs in a timely fashion.
75
+
Check out our dedicated [Bevy Organization document](/docs/the_bevy_organization.md) to learn more about how we're organized.
98
76
99
77
### Classifying PRs
100
78
101
-
This strategy relies on a classification of PRs into three categories: **trivial**, **uncontroversial** and **controversial**.
79
+
Our merge strategy relies on the classification of PRs into three categories: **trivial**, **uncontroversial** and **controversial**.
102
80
When making PRs, try to split out more controversial changes from less controversial ones, in order to make your work easier to review and merge.
103
-
PRs that are deemed controversial will receive the `S-Controversial` label, and will have to go through the more thorough review process.
81
+
PRs that are deemed controversial will receive the [`S-Controversial`](https://github.com/bevyengine/bevy/pulls?q=is%3Aopen+is%3Apr+label%3AS-Controversial) label, and will have to go through the more thorough review process.
104
82
105
83
PRs are trivial if there is no reasonable argument against them. This might include:
106
84
@@ -125,24 +103,27 @@ PRs are controversial if there is serious design discussion required, or a large
125
103
Finally, changes are "relatively uncontroversial" if they are neither trivial or controversial.
126
104
Most PRs should fall into this category.
127
105
128
-
## How we work together
106
+
Here are some useful pull request queries:
107
+
108
+
*[Uncontroversial pull requests which have been reviewed and are ready for maintainers to merge](https://github.com/bevyengine/bevy/pulls?q=is%3Aopen+is%3Apr+label%3AS-Ready-For-Final-Review+-label%3AS-Controversial+-label%3AS-Blocked+-label%3AS-Adopt-Me+)
109
+
*[Controversial pull requests which have been reviewed and are ready for final input from a Project Lead or SME](https://github.com/bevyengine/bevy/pulls?q=is%3Aopen+is%3Apr+label%3AS-Ready-For-Final-Review+label%3AS-Controversial+)
110
+
111
+
### Preparing Releases
129
112
130
-
Making a game engine is a huge project and facilitating collaboration is a lot of work.
131
-
At the moment @cart is our only paid contributor, so [go sponsor him!](https://github.com/sponsors/cart)
132
113
We track issues and pull requests that must be included in releases using [Milestones](https://github.com/bevyengine/bevy/milestones).
133
114
134
-
###Making changes to Bevy
115
+
## Making changes to Bevy
135
116
136
117
Most changes don't require much "process". If your change is relatively straightforward, just do the following:
137
118
138
119
1. A community member (that's you!) creates one of the following:
139
120
*[GitHub Discussions]: An informal discussion with the community. This is the place to start if you want to propose a feature or specific implementation.
140
121
*[Issue](https://github.com/bevyengine/bevy/issues): A formal way for us to track a bug or feature. Please look for duplicates before opening a new issue and consider starting with a Discussion.
141
122
*[Pull Request](https://github.com/bevyengine/bevy/pulls) (or PR for short): A request to merge code changes. This starts our "review process". You are welcome to start with a pull request, but consider starting with an Issue or Discussion for larger changes (or if you aren't certain about a design). We don't want anyone to waste their time on code that didn't have a chance to be merged! But conversely, sometimes PRs are the most efficient way to propose a change. Just use your own judgement here.
142
-
2. Other community members review and comment in an ad-hoc fashion. Active subject matter experts may be pulled into a thread using `@mentions`. If your PR has been quiet for a while and is ready for review, feel free to leave a message to "bump" the thread, or bring it up on [Discord] in an appropriate engine development channel.
123
+
2. Other community members review and comment in an ad-hoc fashion. Active subject matter experts may be pulled into a thread using `@mentions`. If your PR has been quiet for a while and is ready for review, feel free to leave a message to "bump" the thread, or bring it up on [Discord](https://discord.gg/bevy) in an appropriate engine development channel.
143
124
3. Once they're content with the pull request (design, code quality, documentation, tests), individual reviewers leave "Approved" reviews.
144
125
4. After consensus has been reached (typically two approvals from the community or one for extremely simple changes) and CI passes, the [S-Ready-For-Final-Review](https://github.com/bevyengine/bevy/issues?q=is%3Aopen+is%3Aissue+label%3AS-Ready-For-Final-Review) label is added.
145
-
5. When they find time, [someone with merge rights](#how-were-organized) performs a final code review and merges the PR using [Bors](https://bors.tech/) by typing `bors r+`.
126
+
5. When they find time, someone with merge rights performs a final code review and merges the PR using [Bors](https://bors.tech/) by typing `bors r+`.
146
127
147
128
### Complex changes
148
129
@@ -180,7 +161,7 @@ If you release a game on [itch.io](https://itch.io/games/tag-bevy) we'd be thril
180
161
181
162
### Teaching others
182
163
183
-
Bevy is still very young, and light on documentation, tutorials and accumulated expertise.
164
+
Bevy is still very young, and light on documentation, tutorials, and accumulated expertise.
184
165
By helping others with their issues, and teaching them about Bevy, you will naturally learn the engine and codebase in greater depth while also making our community better!
185
166
186
167
Some of the best ways to do this are:
@@ -273,7 +254,7 @@ Not even our project lead is exempt from reviews and RFCs!
273
254
By giving feedback on this work (and related supporting work), you can help us make sure our releases are both high-quality and timely.
274
255
275
256
Finally, if nothing brings you more satisfaction than seeing every last issue labeled and all resolved issues closed, feel free to message @cart for a Bevy org role to help us keep things tidy.
276
-
As discussed in [*How we're organized*](#how-were-organized), this role only requires good faith and a basic understanding of our development process.
257
+
As discussed in our [*Bevy Organization doc*](/docs/the_bevy_organization.md), this role only requires good faith and a basic understanding of our development process.
277
258
278
259
### How to adopt pull requests
279
260
@@ -295,15 +276,6 @@ Then notify org members to close the original.
295
276
296
277
`Adopted #number-original-pull-request`
297
278
298
-
### Maintaining code
299
-
300
-
Maintainers can merge uncontroversial pull requests that have at least two approvals (or at least one for trivial changes).
301
-
302
-
These search filters show the requests that can be merged by maintainers, and those which need a final approval from @cart.
303
-
304
-
1. Pulls requests which are ready for maintainers to merge without consultation: [requests to pull](https://github.com/bevyengine/bevy/pulls?q=is%3Aopen+is%3Apr+label%3AS-Ready-For-Final-Review+-label%3AS-Controversial+-label%3AS-Blocked+-label%3AS-Adopt-Me+)
305
-
2. Pull requests which need final input from @cart: [requests to verify](https://github.com/bevyengine/bevy/pulls?q=is%3Aopen+is%3Apr+label%3AS-Ready-For-Final-Review+label%3AS-Controversial+)
306
-
307
279
### Contributing code
308
280
309
281
Bevy is actively open to code contributions from community members.
@@ -336,7 +308,7 @@ If you end up adding a new official Bevy crate to the `bevy` repo:
336
308
337
309
When contributing, please:
338
310
339
-
* Try to loosely follow the workflow in [*How we work together*](#how-we-work-together).
311
+
* Try to loosely follow the workflow in [*Making changes to Bevy*](#making-changes-to-bevy).
340
312
* Consult the [style guide](.github/contributing/engine_style_guide.md) to help keep our code base tidy.
0 commit comments