Skip to content

docs: add "Which track is my change?" section #239

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
tsanguetaiz10a-ui wants to merge 1 commit into from
Closed

docs: add "Which track is my change?" section #239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
We welcome contributions! We all benefit when new ideas, skills, and reviewer
perspectives are shared across the open-source community.

## Which track is my change?

Before submitting your contribution, please review the relevant guidelines and templates:

@n3wth n3wth Oct 30, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] #221 asks for this section to point at the existing rules, but it doesn't mention them or either track, so the heading's question goes unanswered.

I left the anchor out on purpose. #contribution-tracks--workflow is correct on GitHub, but test_link_integrity.py on main rejects it until the checker fix in #227 lands.

Suggested change
Before submitting your contribution, please review the relevant guidelines and templates:
Pick a track before you open an issue or PR. The rules for each track are in
Contribution Tracks & Workflow below; this section only points to them.

* For bug fixes and minor patches, refer to the [PR template](.github/PULL_REQUEST_TEMPLATE.md).

@n3wth n3wth Oct 30, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] The PR template doesn't decide this: every track uses it, including both Track 2 PRs. What makes a change Track 1 is the limits (non-test diff <= 100 lines, < 3 core files in skills/ or agents/), and a small-looking change to a skill or persona can still be Track 2.

Suggested change
* For bug fixes and minor patches, refer to the [PR template](.github/PULL_REQUEST_TEMPLATE.md).
* **Small fix within the Track 1 limits:** open a PR with the
[PR template](.github/PULL_REQUEST_TEMPLATE.md).

* For features or architectural changes, follow the [feature issue template](.github/ISSUE_TEMPLATE/feature_proposal.md) and consult the [design documentation](docs/designs/README.md).

@n3wth n3wth Oct 30, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P2] "Follow the template" stops at the issue and skips the two-stage flow, and larger changes that aren't features are left out. The link also points at the template file on main, not the new-issue form the Track 2 section uses.

Suggested change
* For features or architectural changes, follow the [feature issue template](.github/ISSUE_TEMPLATE/feature_proposal.md) and consult the [design documentation](docs/designs/README.md).
* **New feature, architectural change, or anything over the Track 1
limits:** open a
[feature proposal issue](https://github.com/google/elephant-goldfish-model/issues/new?template=feature_proposal.md)
and follow the Track 2 steps. Existing design docs are listed in
[docs/designs/README.md](docs/designs/README.md).


Please note that empty or off-topic issues and PRs will be closed.

Comment on lines +12 to +13

@n3wth n3wth Oct 30, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[P3] I asked for this line in #221, but I still can't find the policy anywhere on main (rg -i "off-topic" over the Markdown files and .github/ returns nothing), which is why I asked #223 to drop it. #227 leaves it out too. If it's kept, it should link where the policy is defined; otherwise I'd drop it so all three stay the same.

Suggested change
Please note that empty or off-topic issues and PRs will be closed.

## Design Principles

These general principles guide development of the EGM framework:
Expand Down
Loading