This repository was archived by the owner on Apr 19, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
docs: standardize PR template + CONTRIBUTING (hopper-lens pass) #132
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <!-- | ||
| Keep this short. A tired reviewer at 11pm should grok it in 30 seconds. | ||
| Delete sections that don't apply. Don't add new ones. | ||
| --> | ||
|
|
||
| ## Summary | ||
| <!-- 1-3 sentences. What does this PR do, in plain language? --> | ||
|
|
||
| ## What changed | ||
| - <!-- bulleted facts; one change per bullet --> | ||
|
|
||
| ## Why now | ||
| <!-- One line. Link an issue or motivation. e.g. "Fixes #123" or "Unblocks rollout N." --> | ||
|
|
||
| ## How to verify | ||
| ``` | ||
| # commands a reviewer can paste | ||
| ``` | ||
| Expected: <!-- what they should see --> | ||
|
|
||
| ## Risks / follow-ups | ||
| <!-- Be honest. "None known" is a valid answer. List follow-up issues if any. --> | ||
|
|
||
| ## Related | ||
| <!-- PRs, issues, umbrella work. Delete if none. --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,51 @@ | ||||||||||
| # Contributing | ||||||||||
|
|
||||||||||
| Thanks for showing up. This doc exists so your first PR lands without a scavenger hunt. | ||||||||||
|
|
||||||||||
| ## Setup | ||||||||||
|
|
||||||||||
| ```bash | ||||||||||
| git clone <this-repo> | ||||||||||
| cd <repo> | ||||||||||
| # Chitin-platform repos: `chitin init` bootstraps deps | ||||||||||
| # Go repos: `go build ./...` | ||||||||||
| # Python repos: `uv sync` or `pip install -e .` | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| If setup takes more than one command and a coffee, that's a bug — file an issue. | ||||||||||
|
|
||||||||||
| ## PR naming | ||||||||||
|
|
||||||||||
| We use [Conventional Commits](https://www.conventionalcommits.org/): | ||||||||||
|
|
||||||||||
| ``` | ||||||||||
| <type>(<scope>): <summary> | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| Types: `feat`, `fix`, `docs`, `chore`, `refactor`, `test`, `perf`. | ||||||||||
|
|
||||||||||
| Real examples from this org: | ||||||||||
|
|
||||||||||
| - `feat(session): enrich triple with SoulContext` | ||||||||||
| - `fix(hook): tag governance events with active soul` | ||||||||||
| - `docs: add claws wrapper to GETTING_STARTED` | ||||||||||
|
|
||||||||||
| Scope is optional but helps reviewers route. Keep the summary under 70 chars. | ||||||||||
|
|
||||||||||
| ## PR template | ||||||||||
|
|
||||||||||
| `.github/PULL_REQUEST_TEMPLATE.md` fills in when you open a PR. It's short on purpose. If a section doesn't apply, delete it. If you feel like adding a section, don't — open an issue instead. | ||||||||||
|
|
||||||||||
| ## Review flow | ||||||||||
|
|
||||||||||
| 1. CI + Copilot review run automatically on open. | ||||||||||
| 2. Address Copilot comments before requesting human review (most are legit). | ||||||||||
|
Comment on lines
+41
to
+42
|
||||||||||
| 1. CI + Copilot review run automatically on open. | |
| 2. Address Copilot comments before requesting human review (most are legit). | |
| 1. CI + automated code review run automatically on open. | |
| 2. Address automated review comments before requesting human review (most are legit). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Go setup guidance here only mentions
go build ./..., but this repo’s documented dev workflow includes building./cmd/shellforge/plus running tests and lint (README.md:185-188). Updating this section to reflect the repo’s actual build/test commands will reduce “it builds but fails CI” first-PR friction.