mirror of
https://github.com/onestardao/WFGY.git
synced 2026-04-28 03:29:51 +00:00
Update PULL_REQUEST_TEMPLATE.md
This commit is contained in:
parent
345980df05
commit
b761dd00b8
1 changed files with 145 additions and 7 deletions
152
.github/PULL_REQUEST_TEMPLATE.md
vendored
152
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,8 +1,146 @@
|
|||
### 📌 What’s in this PR
|
||||
* _Short description of fix or new page._
|
||||
## Summary
|
||||
|
||||
### ✅ Checklist
|
||||
- [ ] Added/updated Problem Page or module code
|
||||
- [ ] Added regression trace in `/tests`
|
||||
- [ ] `npm run test` **passes locally**
|
||||
- [ ] Linked related Issue / Discussion
|
||||
Thanks for contributing to WFGY.
|
||||
|
||||
Please describe this PR in 2 to 6 sentences.
|
||||
|
||||
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 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
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue