Make git flow instructions fork-neutral - #1393
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The updated Git flow text is a single very long line in AGENTS.md and should be wrapped for readability and consistency with the project's line-length convention.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the contributor/agent guidance to make the documented Git workflow fork-neutral, avoiding assumptions about origin/upstream remote naming while still directing changes toward the canonical hed-standard/hed-python repository.
Changes:
- Reworded the "Git flow" section to reference the canonical GitHub repo URL explicitly.
- Clarified that contributors should keep local
mainaligned with the upstreammainand use PRs (often via a personal fork) to contribute. - Documented that remote naming conventions vary by checkout and should not be assumed in instructions.
File summaries
| File | Description |
|---|---|
| AGENTS.md | Updates Git flow guidance to be remote-name-agnostic and fork-neutral. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ## Git flow | ||
|
|
||
| Hosted at hed-standard; `origin` is the VisLab fork and `upstream` is hed-standard. Local `main` is a clean mirror of `upstream/main` - never commit or merge to it locally. All work goes on a branch based on `upstream/main`, pushed to the fork, and merged via a PR to hed-standard. | ||
| Hosted at https://github.com/hed-standard/hed-python. Keep local `main` a clean mirror of the hed-standard `main` - never commit or merge to it locally. Do all work on a branch based on that `main` and get it into hed-standard through a pull request, typically pushed to your own fork first. Remote names (`origin`, `upstream`, ...) vary by checkout, so commands here never assume them; your own remote layout is a machine fact for `.status/local-environment.md`. |
There was a problem hiding this comment.
🟡 Changes recommended
The README update is self-referential to PR #1393 and the .gitignore change may unintentionally surface legacy benchmark outputs as untracked files for contributors.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Review details
- Files reviewed: 5/6 changed files
- Comments generated: 1
- Review effort level: Lite
No description provided.