Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add link to RFC Guide from jakobo/rfc #667

Merged
merged 4 commits into from
Apr 8, 2024
Merged

Add link to RFC Guide from jakobo/rfc #667

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3256911
Add link to repo jakobo/rfc, joining a guide for how to set up a comp…
spier Mar 23, 2024
dbe250a
Clarifying which 'Requests for Comments' we are referring to here
spier Mar 23, 2024
9da175f
Fix link syntax
spier Mar 23, 2024
ee2207e
Remove duplicate word
spier Apr 8, 2024
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
3 changes: 2 additions & 1 deletion patterns/2-structured/transparent-cross-team-decision-making-using-rfcs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@

## Solutions

We chose an RFC-like process for increasing the transparency of our cross-team decision making process (also see [Requests for Comments][requests-for-comments]).
We chose an RFC-like process for increasing the transparency of our cross-team decision making process (also see IETF's [Requests for Comments][requests-for-comments]).

Check failure on line 44 in patterns/2-structured/transparent-cross-team-decision-making-using-rfcs.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[ISC.Spelling] Did you really mean 'IETF's'?

Raw Output:
{"message": "[ISC.Spelling] Did you really mean 'IETF's'?", "location": {"path": "patterns/2-structured/transparent-cross-team-decision-making-using-rfcs.md", "range": {"start": {"line": 44, "column": 114}}}, "severity": "ERROR"}

Important elements of the solution are:

Expand All @@ -61,6 +61,7 @@

- [Rust][rust] is a good Open Source example of RFC template and process, and has been the basis for many other RFC processes.
- [Generalized BBC iPlayer & Sounds RFC template](templates/rfc.md), originally based on the [Rust][rust] template
- [jakobo/rfc](https://github.com/jakobo/rfc) outlines how to set up a company-internal RFC process. It contains a [detailed explanation](https://github.com/jakobo/rfc/blob/master/text/0001-using_rfcs.md) of why RFCs are important and an [RFC template](https://github.com/jakobo/rfc/blob/master/0000-template.md) to help you write your first RFC. It contains information such as motivation/rational, guide implementation, a reference implementation, drawbacks, as well as alternatives to the RFC approach. Bonus: The description itself is an RFC, so while reading it you are already getting a sense of how an RFC works.

## Resulting Context

Expand Down
Loading