From af7cffd18b613b8fc38d11298ff9436dc93d366e Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Fri, 20 Aug 2021 14:15:24 -0700 Subject: [PATCH 1/2] Update README with new instructions and add template --- .github/ISSUE_TEMPLATE/new-tracking-issue.md | 21 +++++++++++++++ README.md | 27 +++++++++++++++----- 2 files changed, 41 insertions(+), 7 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/new-tracking-issue.md diff --git a/.github/ISSUE_TEMPLATE/new-tracking-issue.md b/.github/ISSUE_TEMPLATE/new-tracking-issue.md new file mode 100644 index 0000000..49297ab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-tracking-issue.md @@ -0,0 +1,21 @@ +--- +name: "New Tracking Issue" +about: "Track something that should be done in an upstream repository." +--- + + + +# Summary + +A one-sentence summary of the issue. + +# Links to upstream issues / PRs + +_A list of links to the upstream issues/PRs where this work is being discussed and developed._ + +- [ ] Link 1 +- [ ] ... diff --git a/README.md b/README.md index 210ea5a..26db7b3 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,28 @@ This is a lightweight repository to facilitate planning deliverables and tasks for projects that do not have a natural repository inside of 2i2c. -Its primary use it to hold issues that point to other open source projects, so that we may keep track of them in our workflows more effectively. -It is meant to be used in conjunction with the [team workflow described here](https://team-compass.2i2c.org/en/latest/practices/coordination.html). +## Goals of this repository -# Guidelines for use +2i2c needs to coordinate its priorities and work as a team, but doesn't wish to create silos of discussion around work that happens in upstream communities. The `external/` repository exists to be a bridge between 2i2c's work and these communities. -**Use Project Labels**. Each issue in this repository should have a **Project Label**. -These are labels structured like `proj: `. +We want this repository to be as lightweight as possible - it is just a place for us to keep track of items we wish to work on, not a place for discussion. + + +## How to use this repository + +**Create tracking issues only**. +Each issue in this repository should be a **tracking issue** that points somewhere else. For example, to one or more issues or pull requests in an upstream repository. + +**Do not use this repository for long-term planning**. +Any longer-term planning or roadmapping should be done in an upstream repository. We do not use this repository to project plan over longer periods of time, *only* to track issues that we want to work on soon (say, within a few sprints). + +**Upstream issues should exist first**. +Upstream issues are the "real" location for discussion, and should exist first before issues are created here. Any decisions about implementation should already happen upstream before we decide to work on something ourselves. + +**Each issue should have a project label**. +These are GitHub labels structured like `proj: `. The project label helps us know where else an issue refers to, and helps team members filter and sort them in our project boards. -**Cross-link to open source projects**. For issues that refer to actions to take in other open source projects, make sure to include a link in your issue that points to where discussion / tracking is happening elsewhere. -In general, we don't want this repository to contain too much information, just labels to help us organize, and pointers to other repositories where the action is happening. +**Conversations happen in upstream repositories**. +If there are conversations that must happen around the work, these should happen in upstream repositories, not here. The "comments" in any of the issues in this repository should be as minimal as possible. From 0921972101e97f6e5659a3d177d41dd80d5f5e3a Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Mon, 23 Aug 2021 10:32:22 -0700 Subject: [PATCH 2/2] External -> upstream --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 26db7b3..13fadc4 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# Coordinating external work +# Coordinating upstream work This is a lightweight repository to facilitate planning deliverables and tasks for projects that do not have a natural repository inside of 2i2c. ## Goals of this repository -2i2c needs to coordinate its priorities and work as a team, but doesn't wish to create silos of discussion around work that happens in upstream communities. The `external/` repository exists to be a bridge between 2i2c's work and these communities. +2i2c needs to coordinate its priorities and work as a team, but doesn't wish to create silos of discussion around work that happens in upstream communities. The `upstream/` repository exists to be a bridge between 2i2c's work and these communities. We want this repository to be as lightweight as possible - it is just a place for us to keep track of items we wish to work on, not a place for discussion.