Skip to content

Commit 4a7544c

Browse files
authored
Merge pull request #1402 from nrkno/chore/contribution-guidelines-rfc-clarification
chore(docs): Clarify the RFC process more
2 parents fccbcb1 + e66e0e6 commit 4a7544c

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

packages/documentation/docs/for-developers/contribution-guidelines.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,22 @@ Before you start, there are a few things you should know:
3030

3131
**Minor changes** (most bug fixes and small features) can be submitted directly as pull requests to the appropriate official repo.
3232

33-
However, Sofie is a big project with many differing users and use cases. **Larger changes** might be more difficult to merge into an official repository if NRK has not been made aware of their existence beforehand. To facilitate a timely handling of larger contributions, there’s a workflow intended to keep an open dialogue between all interested parties:
33+
However, Sofie is a big project with many differing users and use cases. **Larger changes** may be difficult to merge into an official repository if NRK and other contributors have not been made aware of their existence beforehand. Since figuring out what side-effects a new feature or a change may have for other Sofie users can be tricky, we advise opening an RFC issue (_Request for Comments_) early in your process. Good moments to open an RFC include:
34+
* When a user need is identified and described
35+
* When you have a rough idea about how a feature may be implemented
36+
* When you have a sketch of how a feature could look like to the user
37+
38+
To facilitate timely handling of larger contributions, there’s a workflow intended to keep an open dialogue between all interested parties:
3439

3540
1. Contributor opens an RFC (as a _GitHub issue_) in the appropriate repository.
3641
2. NRK evaluates the RFC, usually within a week.
37-
3. (If needed) NRK establishes contact with the RFC author, who will be invited to a workshop where the RFC is discussed. Meeting notes are published publicly on the RFC thread.
38-
4. The contributor references the RFC when a pull request is ready.
42+
3. If needed, NRK establishes contact with the RFC author, who will be invited to a workshop where the RFC is discussed. Meeting notes are published publicly on the RFC thread.
43+
4. Discussions about the RFC continue as needed, either in workshops or in comments in the RFC thread.
44+
5. The contributor references the RFC when a pull request is ready.
45+
46+
It will be very helpful if your RFC includes specific use-cases that you are facing. Providing a background on how your users are using Sofie can clear up situations in which certain phrases or processes may be ambiguous. If during your process you have already identified various solutions as favorable or unfavorable, offering this context will move the discussion further still.
47+
48+
Via the RFC process, we're looking to maximize involvement from various stakeholders, so you probably don't need to come up with a very detailed design of your proposed change or feature in the RFC. An end-user oriented description will be most valuable in creating a constructive dialogue, but don't shy away from also adding a more technical description, if you find that will convey your ideas better.
3949

4050
### Base contributions on the in-development branch
4151
In order to facilitate merging, we ask that contributions are based on the latest (at the time of the pull request) _in-development_ branch (often named `release*`).

0 commit comments

Comments
 (0)