Skip to content

Commit 16c7ca8

Browse files
committed
chore: add a paragraph about contents of the RFC
1 parent 98bd2af commit 16c7ca8

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ To facilitate timely handling of larger contributions, there’s a workflow inte
4343
4. Discussions about the RFC continue as needed, either in workshops or in comments in the RFC issue.
4444
5. The contributor references the RFC when a pull request is ready.
4545

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.
49+
4650
### Base contributions on the in-development branch
4751
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*`).
4852
See **CONTRIBUTING.md** in each official repository for details on which branch to use as a base for contributions.

0 commit comments

Comments
 (0)