Skip to content

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

Closed
tsanguetaiz10a-ui wants to merge 1 commit into
google:mainfrom
tsanguetaiz10a-ui:patch-1
Closed

tsanguetaiz10a-ui wants to merge 1 commit into
google:mainfrom
tsanguetaiz10a-ui:patch-1

Conversation

@tsanguetaiz10a-ui

Copy link
Copy Markdown

Fixes #221

This PR adds the "Which track is my change?" section right before the "Design Principles" section in CONTRIBUTING.md. It includes links to the PR template, feature issue template, and design documentation README, along with the warning about empty/off-topic PRs.

Contribution Type

Please select the track that matches this pull request:

  • Bug Fix / Minor Patch (Targeted fix, non-test diff <= 100 lines and < 3 core files in skills/ or agents/; no design doc required)
  • Feature / Architectural Change -- Stage 1: Design Doc PR (Refs #___ with design-ready | Adds docs/designs/<name>.md and updates docs/designs/README.md; use Refs instead of Closes so the issue stays open for Stage 2)
  • Feature / Architectural Change -- Stage 2: Implementation PR (Closes #___ with pr-ready | Implements merged docs/designs/<name>.md)

Summary of Key Changes

  • Added a new "Which track is my change?" section before "Design Principles".
  • Included links to the PR template, feature issue template, and design documentation.
  • Added a clear warning that empty or off-topic issues and PRs will be closed.

Human Accountability Affirmation

  • I am a human contributor. I have personally reviewed, understood, and can explain every line of this change in review (using AI tools to write code is welcome, but human understanding of the submitted change is required).

Verification

  • For Bug Fix / Implementation PRs (Stage 2): Unit tests or test_scenarios.yaml added/updated and pytest tests/unit executed.
    (Note: This is a documentation-only change, so no code tests were required. The markdown was previewed locally to ensure correct formatting.)

Added a new section before Design Principles as requested in google#221. This includes links to the PR template, feature issue template, and design documentation.
@google-cla

google-cla Bot commented Oct 30, 2026

Copy link
Copy Markdown

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@n3wth n3wth left a comment

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.

Reviewed 294a14e. I can't approve this as it stands. The section links the right files, but it leaves out the conditions in the Tracks section it is meant to route to, so a contributor who reads only this part could take the wrong path.

[P2] This is the third PR for #221. #223 and #227 add the same section, and I have approved both. Only one of the three should merge, and #227 is furthest along since it also carries the link-checker fix. If this one has nothing those two lack, it can be closed once one of them lands.

[P2] The section never names a track or points to the rules, and both bullets drop conditions: the first has no Track 1 limits, and the second skips the design-ready / design doc PR / pr-ready sequence. Details and suggestions inline.

[P3] The closing line still has nothing behind it on main. Inline.

The Verification box says pytest tests/unit was executed, but the note under it says no tests were required. Please say which it was, since #221 asks for the unit suite to pass.

The PR template, feature_proposal.md and docs/designs/README.md all exist on main. Only CONTRIBUTING.md changes, so I did not run the unit tests. cla/google fails on this head, and the Tests workflow has not run.

Comment thread CONTRIBUTING.md

## Which track is my change?

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

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.

Comment thread CONTRIBUTING.md
## Which track is my change?

Before submitting your contribution, please review the relevant guidelines and templates:
* For bug fixes and minor patches, refer to the [PR template](.github/PULL_REQUEST_TEMPLATE.md).

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).

Comment thread CONTRIBUTING.md

Before submitting your contribution, please review the relevant guidelines and templates:
* For bug fixes and minor patches, refer to 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).

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).

Comment thread CONTRIBUTING.md
Comment on lines +12 to +13
Please note that empty or off-topic issues and PRs will be closed.

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.

@n3wth

n3wth commented Oct 30, 2026

Copy link
Copy Markdown
Collaborator

Superseded by merged #227, which supplies the same contribution-track overview plus the GitHub anchor correction and regression coverage. No additional change is needed here. Thank you for contributing.

@n3wth n3wth closed this Oct 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show contribution tracks at the top of CONTRIBUTING.md

2 participants