Repository navigation
docs: add "Which track is my change?" section - #239
tsanguetaiz10a-ui wants to merge 1 commit into
Conversation
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.
|
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
left a comment
There was a problem hiding this comment.
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.
|
|
||
| ## Which track is my change? | ||
|
|
||
| Before submitting your contribution, please review the relevant guidelines and templates: |
There was a problem hiding this comment.
[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.
| 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. | |
| ## 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). |
There was a problem hiding this comment.
[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.
| * 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). |
|
|
||
| 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). |
There was a problem hiding this comment.
[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.
| * 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. | ||
|
|
There was a problem hiding this comment.
[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.
| Please note that empty or off-topic issues and PRs will be closed. |
|
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. |
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:
skills/oragents/; no design doc required)Refs #___withdesign-ready| Addsdocs/designs/<name>.mdand updatesdocs/designs/README.md; useRefsinstead ofClosesso the issue stays open for Stage 2)Closes #___withpr-ready| Implements mergeddocs/designs/<name>.md)Summary of Key Changes
Human Accountability Affirmation
Verification
test_scenarios.yamladded/updated andpytest tests/unitexecuted.(Note: This is a documentation-only change, so no code tests were required. The markdown was previewed locally to ensure correct formatting.)