Skip to content

Commit 9b52840

Browse files
authored
Merge pull request #778 from z-shell/feature-linear-tracker
docs(community): transition from GitHub Projects to Linear
2 parents 18d765b + 8977245 commit 9b52840

4 files changed

Lines changed: 41 additions & 54 deletions

File tree

community/00_contributing/05_project_management.mdx

Lines changed: 38 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -23,100 +23,87 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
2323
<img src={useBaseUrl("/img/svg/community/contributing-project-management.svg")} alt="" width="100" height="100" style={{borderRadius: "16px"}}/>
2424
</div>
2525

26-
## Project Tracker
26+
## Linear Tracker
2727

28-
All work across the Z-Shell organization is tracked in a single unified project:
28+
Planned, active, and deferred work across the Z-Shell organization is
29+
prioritized in the **Z-Shell Workspace** project in Linear:
2930

3031
<Link
3132
className="button button--primary button--lg"
32-
to="https://github.com/orgs/z-shell/projects/28"
33+
to="https://linear.app/ss-o/project/z-shell-workspace-0206c6a7192d"
3334
>
34-
Z-Shell Tracker
35+
Open Linear
3536
</Link>
3637

3738
<br />
3839
<br />
3940

40-
The project pulls issues and pull requests from every repository in the
41-
[`z-shell`](https://github.com/z-shell) GitHub organization into one place, so
42-
nothing slips through the cracks.
41+
GitHub issues and pull requests remain the repository-level record for
42+
discussion, implementation, and review. Linear provides the cross-repository
43+
planning view: priority, status, ownership, estimates, cycles, and dependencies.
4344

44-
### Project Views
45+
### Workflow
4546

46-
| View | Layout | Purpose |
47-
| --- | --- | --- |
48-
| **Triage** | Table | New items awaiting investigation — start here |
49-
| **Bugs Board** | Board | Active bug work, grouped by Status |
50-
| **Features Board** | Board | Feature and enhancement work |
51-
| **Active Sprint** | Board | Everything in the current 2-week sprint |
52-
| **Roadmap** | Roadmap | Planned work on a timeline |
53-
| **By Repository** | Table | All items grouped by source repo |
54-
55-
### Custom Fields
47+
Each tracked item moves through the z-shell team's Linear workflow:
5648

57-
Each item in the project can have the following fields set:
58-
59-
| Field | Values | Notes |
60-
| --- | --- | --- |
61-
| **Status** | Triage · Todo · In Progress · In Review · Done · Blocked · Won't Fix | Set by maintainers during triage |
62-
| **Priority** | 🔴 Critical · 🟠 High · 🟡 Medium · 🔵 Low · None | |
63-
| **Item Type** | Bug · Feature · Enhancement · Docs · Security · Performance · Chore · CI | |
64-
| **Effort** | XS · S · M · L · XL | Rough size estimate |
65-
| **Sprint** | Sprint 1 … Sprint N | 2-week iterations starting Mondays |
49+
| Status | Purpose |
50+
| --- | --- |
51+
| **Backlog** | Accepted work that is not yet scheduled |
52+
| **Todo** | Ready to begin |
53+
| **In Progress** | Actively being implemented |
54+
| **In Review** | Awaiting review, verification, or publication |
55+
| **Done** | Completed and verified |
56+
| **Canceled** | Deliberately removed from the plan |
57+
| **Duplicate** | Covered by another tracked item |
6658

6759
### Triage Workflow
6860

69-
New issues and PRs are automatically added to the project with **Status = Triage**.
70-
A maintainer reviews the item and:
61+
When work is added to Linear, a maintainer:
7162

72-
1. Sets **Item Type** (Bug, Feature, etc.)
73-
2. Sets **Priority**
74-
3. Moves **Status** to `Todo` (or `Won't Fix` / `Blocked` if appropriate)
75-
4. Assigns to a **Sprint** if it should be worked on soon
76-
5. Adds the appropriate [label](#labels)
63+
1. Links the owning GitHub issue or pull request when one exists.
64+
2. Sets its **Priority**, **Status**, and project.
65+
3. Adds labels and an estimate when they improve planning.
66+
4. Records dependencies so blocked work is visible.
67+
5. Assigns it to a cycle only when it is ready to schedule.
7768

7869
### Capturing Deferred Work
7970

8071
Do not leave postponed work only in local diffs, review notes, or memory.
81-
Create or update an issue in the repository that owns the work so it is added to
82-
the shared tracker automatically.
72+
Create or update an issue in the repository that owns the work, then add or link
73+
the corresponding Linear item when the task needs cross-repository planning.
8374

8475
When splitting or deferring work:
8576

8677
1. Create **one issue per logical task** so each item can be prioritized and completed independently.
8778
2. Include enough context for another maintainer to resume later: the observed problem, why it matters, relevant files, and any known constraints.
88-
3. Suggest the likely **Item Type**, **Priority**, and **Effort** during triage.
79+
3. Suggest the likely **Priority**, estimate, and initial Linear status during triage.
8980
4. Use the canonical labels instead of repo-local tracking conventions.
9081

91-
### Sprint Cadence
92-
93-
Sprints run for **2 weeks**, starting every other Monday.
94-
95-
At the end of each sprint, incomplete items are moved to the next sprint or
96-
returned to the backlog (`Todo` without a sprint assignment).
97-
9882
### Priority Definitions
9983

10084
| Priority | Meaning |
10185
| --- | --- |
10286
| 🔴 **Critical** | Data loss, security vulnerability, or complete breakage with no workaround |
103-
| 🟠 **High** | Significantly impacts users; should be in the current or next sprint |
104-
| 🟡 **Medium** | Important but not urgent; planned within the next few sprints |
87+
| 🟠 **High** | Significantly impacts users or blocks important work; schedule next |
88+
| 🟡 **Medium** | Important but not urgent; prioritize against other planned work |
10589
| 🔵 **Low** | Nice to have; no fixed timeline |
10690
| **None** | Not yet triaged or genuinely optional |
10791

108-
### Automation
92+
### GitHub and Linear
10993

110-
Every repository in the organization has a `.github/workflows/project-tracker.yml`
111-
workflow that automatically adds new issues and pull requests to the project. No
112-
manual steps are required from contributors.
94+
Contributors should continue opening issues and pull requests in the owning
95+
GitHub repository. Maintainers use Linear to coordinate work that spans
96+
repositories, needs scheduling, or should remain visible after it is deferred.
97+
Links between the two systems preserve the implementation history without
98+
duplicating long-form technical context.
11399

114100
---
115101

116102
## Labels
117103

118104
All repositories in the `z-shell` organization use the same canonical label set.
119-
Labels are applied automatically by the stale bot or manually during triage.
105+
Labels are applied manually during triage or by approved organization
106+
automation.
120107

121108
The source of truth lives in
122109
[`z-shell/.github/.github/lib/labels.yml`](https://github.com/z-shell/.github/blob/main/.github/lib/labels.yml).

community/00_contributing/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Choose the path that matches what you want to do:
6868
| --- | --- |
6969
| 👥 Join the team | [Open a membership request](https://github.com/z-shell/.github/issues/new?assignees=&labels=type%3A+membership%2Carea%3A+meta&template=05_membership.yml&title=team%3A+) |
7070
| 🌐 Translate | [translate.zshell.dev](https://translate.zshell.dev) |
71-
| 📋 Project tracker | [Z-Shell Tracker](https://github.com/orgs/z-shell/projects/28) |
71+
| 📋 Project tracker | [Linear](https://linear.app/ss-o/project/z-shell-workspace-0206c6a7192d) |
7272
| 💬 Discuss | [GitHub Discussions](https://github.com/z-shell/zi/discussions) |
7373

7474
## General Guidelines

community/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The Z-Shell community is home to contributors, plugin authors, and Zsh enthusias
2929
</div>
3030

3131
:::info[Get involved]
32-
Join the [Z-Shell organization](https://github.com/z-shell), help [translate the wiki](https://translate.zshell.dev), or track work in the [Z-Shell Tracker](https://github.com/orgs/z-shell/projects/28).
32+
Join the [Z-Shell organization](https://github.com/z-shell), help [translate the wiki](https://translate.zshell.dev), or track work in the [Z-Shell Workspace](https://linear.app/ss-o/project/z-shell-workspace-0206c6a7192d).
3333
:::
3434

3535
## Community Sections

static/img/svg/community/contributing-project-management.svg

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)