Skip to content

Commit

Permalink
add guidance on PR to close #943
Browse files Browse the repository at this point in the history
  • Loading branch information
jmunroe committed Mar 6, 2025
1 parent d41fc0f commit 4f05a3a
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ It is our team's primary knowledge base.
**The Team Compass is the {term}`Source of Truth`!**

If you see information that is out of date, propose an edit in [the team compass repository](https://github.com/2i2c-org/team-compass).
To propose an edit directly from the documentation, click {fab}`github` -> {fas}`pencil-alt`.
To propose an edit directly from the documentation, click {fab}`github` -> {fas}`pencil-alt`. See [Update the Team Compass](operations/team-compass.md#update-the-team-compass) for more details.

[^team-compass]: For more about the Team Compass itself, see [](operations/team-compass.md).

Expand Down
18 changes: 17 additions & 1 deletion operations/team-compass.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,26 @@ There are a few major reasons why we use a Team Compass:

## Update the team compass

The Team Compass should be updated frequently as information about 2i2c changes.
The 2i2c Team Compass is a living document and should be frequently updated reflect our current practices
and policies. Any 2i2c team member is welcome and encouraged to propose changes to the Team Compass to ensure it
serves it function as the {term}`Source of Truth` for the organization.

Do not hesitate to propose a change!
See [our Documentation Guide](../reference/documentation/overview.md) for instructions of how to edit our Team Compass (and other documentation that 2i2c uses).

The following procedure provides guidance on submitting, reviewing, and merging pull requests for the Team Compass.
If there is an ambiguity in this procedure, see [Making decisions at 2i2c](governance.md#making-decisions-at-2i2c) for the principles motivating these guidelines.

- If a PR is related to an issue from another repository with the 2i2c organization, include a reference to that issue in the PR description. **Leave a paper trail**.
- PRs that concern minor grammatical fixes, updates of broken links, or a style changes that improves readability should be self-merged without review. **Trust one another**.
- PRs that involve a policy or procedural change within a team should be reviewed by at least one other member of that team. **Consult the right people**.
- If a team has already decided on a process, and the Team Compass is simply out-of-date, then it's acceptable to self-merge a PR without approval (even if the PR is simply to delete out-of-date process and link to another document that defines our current process). **Iterate on the core ideas.**
- Once a PR has been approved via a review, it can be merged by anyone. **Bias towards action**.
- A PR should not remain open for more than a week. **Timebox the discussion**.
- PRs are always welcome. If something seems unclear or incorrect to you, it likely needs improvement. **Make it safe to try**.

If there a concern that "it is too much work to adapt <pre-existing process doc> to make a PR" and that is blocking updating the Team Compass, it is better to delete a section and add a sentence like "the process for this is documented at [this link]() ". The Team Compass can delegate authority for a process to other places.

## What is a Source of Truth

The Team Compass is a {term}`Single Source of Truth`, meaning that it is the definitive answer for questions about 2i2c's policy and state.
Expand Down

0 comments on commit 4f05a3a

Please sign in to comment.