Skip to content

Commit 5217981

Browse files
authored
docs(contributing): link account repository model (#7)
Link the canonical account model and align ready-task guidance with the small-fix exception. Closes #6.
1 parent 3b48683 commit 5217981

1 file changed

Lines changed: 9 additions & 4 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,10 @@ submodule checkout, as an implementation target.
2121
1. Check the repository's [Issues](https://github.com/codegeist-ai/codegeist-devcontainer-kit/issues)
2222
and [roadmap listing](https://github.com/users/codegeist-ai/projects/1) before
2323
starting overlapping work.
24-
2. Link the Issue to a local task under `docs/tasks/` when the work needs a
25-
resumable specification. Follow the [task guide](docs/tasks/README.md).
24+
2. An Issue labeled `status:ready` must link its canonical local task under
25+
`docs/tasks/`. For a small unplanned fix, a maintainer may confirm that no new
26+
task is needed; state the reason in the pull request. Always use an existing
27+
task when one defines the work. Follow the [task guide](docs/tasks/README.md).
2628
3. Make the smallest source change on a branch based on `main`.
2729
4. Run the normal deterministic check:
2830

@@ -33,8 +35,10 @@ submodule checkout, as an implementation target.
3335
5. Run `task tests-run` when changing the image, Dev Containers lifecycle,
3436
Docker/Compose behavior, QEMU, browser runtime, or another contract covered
3537
only by the broad integration suite.
36-
6. Open a pull request that links the public Issue and local task, explains the
37-
source and release impact, and records the verification performed.
38+
6. Open a pull request that links the public Issue and applicable local task,
39+
explains the source and release impact, and records the verification performed.
40+
If no new task was required, state `No local task needed:` and the
41+
maintainer-approved reason.
3842

3943
`task check` validates shell syntax and focused source-to-release contracts. It
4044
is non-interactive, does not build the image or start Docker, QEMU, Dev
@@ -73,6 +77,7 @@ The separate [`codegeist-ai/.github`](https://github.com/codegeist-ai/.github)
7377
repository remains the source for shared community defaults used here and in
7478
other Codegeist repositories.
7579

80+
- [GitHub account and repository model](https://github.com/codegeist-ai/.github/blob/main/GITHUB_ACCOUNT_MODEL.md)
7681
- [Code of Conduct](https://github.com/codegeist-ai/.github/blob/main/CODE_OF_CONDUCT.md)
7782
- [Security Policy](https://github.com/codegeist-ai/.github/blob/main/SECURITY.md)
7883
- [Support Policy](https://github.com/codegeist-ai/.github/blob/main/SUPPORT.md)

0 commit comments

Comments
 (0)