Expand RFC Pattern by tsadler1988 · Pull Request #245 · InnerSourceCommons/InnerSourcePatterns · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
4f3a31b
Add 'Story' to RFC pattern
tsadler1988 Dec 13, 2020
84f1bf4
Add BBC known instance of RFC pattern
tsadler1988 Dec 13, 2020
cbef327
Add missing full stop
tsadler1988 Dec 13, 2020
1ec05e3
Add Google Design Docs to RFC pattern
tsadler1988 Dec 13, 2020
277e424
Expand on waterfall risk of RFC pattern
tsadler1988 Dec 13, 2020
740764d
Expand on Solutions
tsadler1988 Dec 14, 2020
91d5204
Expand on Resulting Context
tsadler1988 Dec 14, 2020
0782e5d
Add ADRs with note to Aliases
tsadler1988 Dec 14, 2020
49f7866
Update status to 'Structured'
tsadler1988 Dec 14, 2020
e26d7df
Move RFC pattern to structured
tsadler1988 Dec 14, 2020
9f2ec2a
Move RFC pattern in README up to maturity level 2
tsadler1988 Dec 14, 2020
6561f1e
Fix broken link to RFC pattern in README
tsadler1988 Dec 14, 2020
8d63dd9
Merge branch 'master' into rfc-v2
tsadler1988 Dec 15, 2020
0b5da64
Update patterns/2-structured/transparent-cross-team-decision-making-u…
spier Dec 25, 2020
74ea142
Merge branch 'master' into rfc-v2
lenucksi Jan 1, 2021
c930b60
Merge branch 'master' into rfc-v2
spier Jan 8, 2021
6f9fb74
Update patterns/2-structured/transparent-cross-team-decision-making-u…
spier Jan 8, 2021
9a60cfc
Update patterns/2-structured/transparent-cross-team-decision-making-u…
lenucksi Jan 10, 2021
801ab27
Update patterns/2-structured/transparent-cross-team-decision-making-u…
tsadler1988 Jan 12, 2021
f3dd23c
Update patterns/2-structured/transparent-cross-team-decision-making-u…
tsadler1988 Jan 12, 2021
46786f7
Add RFC template
tsadler1988 Jan 12, 2021
6e6ce0a
Fix linting errors
tsadler1988 Jan 12, 2021
05acb0b
Update patterns/2-structured/templates/rfc.md
spier Jan 12, 2021
8151d10
Merge branch 'rfc-v2' of github.com:tsadler1988/InnerSourcePatterns i…
tsadler1988 Jan 12, 2021
dd95361
Update patterns/2-structured/templates/rfc.md
spier Jan 12, 2021
47ab769
Update patterns/2-structured/templates/rfc.md
spier Jan 12, 2021
18319b9
Remove unnecessary blank lines
tsadler1988 Jan 12, 2021
056a3bb
Remove duplicate entry of RFC pattern in maturity level 1
tsadler1988 Jan 12, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
91 changes: 91 additions & 0 deletions patterns/2-structured/templates/rfc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# 000-Template

- Feature Name: (fill me in with a unique ident, `my_awesome_feature`)
- Start Date: (fill me in with today's date, YYYY-MM-DD)
- Nominated owners: (Representatives of technical ownership areas affected by the RFC. This will often be tech leads, but they may delegate. RFCs cannot be accepted until all nominated owners have signed off.)

## Summary

One paragraph explanation of the feature.

## Retrospective

This section is essential to allow us to learn from the things we are implementing.

_When is the retrospective?_

[ ] Retro completed?

(where/how it will be held, how can people get involved, where are the results?)

## Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

## Guide-level explanation

Explain the proposal as if it was already existing and you were teaching it to another engineer. That generally means:

- Introducing new named concepts.
- Explaining the feature largely in terms of examples.
- Explaining how engineers should think about the feature. It should explain the impact as concretely as possible.
- If applicable (eg code/architecture proposal), provide sample error messages, deprecation warnings, or migration guidance.
- If applicable, describe the differences between teaching this to existing engineers and new engineers.

For implementation-oriented RFCs, this section should focus on how contributors should think about the change, and give examples of its concrete impact. For policy/process RFCs, this section should provide an example-driven introduction to the policy/process, and explain its impact in concrete terms.

## Reference-level explanation

This is the technical portion of the RFC. Explain the design in sufficient detail that:

- Its interaction with other features is clear.
- It is reasonably clear how the feature would be implemented.
- Corner cases are dissected by example.

The section should return to the examples given in the previous section, and explain more fully how the detailed proposal makes those examples work.

## Drawbacks

Why should we _not_ do this?

## Rationale and alternatives

- Why is this design the best in the space of possible designs?
- What other designs have been considered and what is the rationale for not choosing them?
- What is the impact of not doing this?

## Prior art

Discuss prior art, both the good and the bad, in relation to this proposal.
A few examples of what this can include are:

- For language, library, tools etc: Does this feature exist in other places and what experience have their community had?
- For community proposals: Is this done by some other community and what were their experiences with it?
- For other teams: What lessons can we learn from what other communities have done here?
- Papers: Are there any published papers or great posts that discuss this? If you have some relevant papers to refer to, this can serve as a more detailed theoretical background.

This section is intended to encourage you as an author to think about the lessons from other places, provide readers of your RFC with a fuller picture.
If there is no prior art, that is fine - your ideas are interesting to us whether they are brand new or if it is an adaptation from other places.

## Unresolved questions
Comment thread
spier marked this conversation as resolved.

- What parts of the design do you expect to resolve through the RFC process before this gets merged?
Comment thread
spier marked this conversation as resolved.
- What parts of the design do you expect to resolve through the implementation of this feature before stabilization?
- What related issues do you consider out of scope for this RFC that could be addressed in the future independently of the solution that comes out of this RFC?

## Future possibilities

Think about what the natural extension and evolution of your proposal would
be and how it would affect the teams and projects as a whole in a holistic
way. Try to use this section as a tool to more fully consider all possible
interactions with the project and teams in your proposal.
Also consider how the this all fits into the roadmap for the project
and of the relevant sub-team.
This is also a good place to "dump ideas", if they are out of scope for the
RFC you are writing but otherwise related.
If you have tried and cannot think of any future possibilities,
you may simply state that you cannot think of anything.
Note that having something written down in the future-possibilities section
is not a reason to accept the current or a future RFC; such notes should be
in the section on motivation or rationale in this or subsequent RFCs.
The section merely provides additional information.