Merge pull request #121 from onestardao/pull_request_template.md

Add structured pull request template
This commit is contained in:
PSBigBig + MiniPS 2026-03-09 14:24:15 +08:00 committed by GitHub
commit d66de248f8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,13 +1,146 @@
## What changed
## Summary
Describe the change you are proposing.
Thanks for contributing to WFGY.
## Why
Please describe this PR in 2 to 6 sentences.
Explain why this change is useful or necessary.
Explain:
- what changed
- where it changed
- why it matters
---
## What this PR changes
Check all that apply.
- [ ] Documentation wording or structure
- [ ] Navigation or routing improvement
- [ ] Recognition or public proof update
- [ ] Adopters / Case Evidence / Evidence Timeline update
- [ ] Collaboration or pilot-related page
- [ ] Template or contribution workflow
- [ ] Metadata or repository structure
- [ ] Bug fix
- [ ] Other
---
## Affected surfaces
List the main files or pages touched by this PR.
Examples:
- `README.md`
- `ADOPTERS.md`
- `CASE_EVIDENCE.md`
- `EVIDENCE_TIMELINE.md`
- `WORK_WITH_WFGY.md`
- `PILOT_OFFER_ONE_PAGER.md`
- `SAMPLE_DELIVERABLE.md`
- `ECOSYSTEM_MAP.md`
- `.github/ISSUE_TEMPLATE/...`
---
## Why this matters
Explain why this change is useful.
Good examples:
- reduces confusion for new readers
- improves routing between related pages
- adds verifiable public proof
- clarifies boundaries or non-claims
- improves contributor workflow
- fixes a broken or misleading repo surface
---
## Linked issue
If this PR is related to an issue, link it here.
Examples:
- Closes #123
- Related to #456
- No linked issue
---
## Public proof or evidence
Fill this section only if the PR adds or changes public proof.
### Source or project name
Example:
- LlamaIndex
- RAGFlow
- ToolUniverse
- Multimodal RAG Survey
### Public link
Add the stable public link here.
### Conservative reading
Explain how this should be read carefully.
Examples:
- merged docs integration
- public mention only
- research-facing citation
- packaging milestone
- not evidence of paid adoption
### Suggested placement
If relevant, say where this belongs.
Examples:
- Recognition Map only
- Adopters
- Case Evidence
- Evidence Timeline
---
## Screenshots or render checks
If this PR affects formatting, templates, rendering, or visual routing, add screenshots or notes here.
If not relevant, write:
- Not applicable
---
## Non-claims and boundaries
State anything this PR does **not** prove or should **not** be read as proving.
This is especially important for:
- public proof pages
- collaboration pages
- pilot materials
- ecosystem interpretation pages
Examples:
- this does not prove paid adoption
- this does not imply production deployment
- this does not change the canonical role of the page
- this is a structural clarification, not a product claim
---
## Checklist
- [ ] I have read the CONTRIBUTING guide
- [ ] This change does not break existing documentation
- [ ] I have explained the motivation for this change
- [ ] I reviewed the changed text for clarity and consistency
- [ ] I checked links, filenames, and page references
- [ ] I kept claims conservative and evidence-based
- [ ] If this PR adds public proof, I included a stable public source
- [ ] If this PR affects routing, I checked whether the destination pages are correct
- [ ] I avoided overstating adoption, deployment, or collaboration status
- [ ] I updated related pages when necessary, or intentionally left them unchanged