add gitHub community files for contributors and AI-assisted development#2347
add gitHub community files for contributors and AI-assisted development#2347swstica wants to merge 5 commits into
Conversation
Greptile SummaryThis PR adds two new community documentation files —
Confidence Score: 5/5Documentation-only change with no impact on executable code or hardware-facing logic — safe to merge. Both files are pure markdown documentation. No code paths, data models, or runtime behaviour are affected. The two issues found (a broken TOC anchor and a scope inconsistency between the two files) are content-level nits that do not block contributors or break any tooling. No files require special attention beyond the minor content fixes noted in the inline comments. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Contributor wants to contribute] --> B{Type of contribution?}
B --> |Bug / Feature idea| C[Open a Discussion]
B --> |Accepted issue exists| D[Fork & implement]
C --> E{Maintainer accepts?}
E --> |No| F[Discussion stays open]
E --> |Yes| G[Promoted to Issue]
G --> D
D --> H{Touches hardware?}
H --> |Yes| I[Test in simulation/replay\nUnderstand every line]
H --> |No| J[Run uv run pytest & pre-commit]
I --> J
J --> K[Open Pull Request]
K --> L{AI-assisted?}
L --> |Yes| M[Disclose tool & scope in PR description]
L --> |No| N[Fill out PR template]
M --> N
N --> O[Sign CLA]
O --> P[Maintainer review]
P --> Q{Approved?}
Q --> |Yes| R[Merged to main]
Q --> |No| S[Address feedback]
S --> P
Reviews (5): Last reviewed commit: "Merge branch 'main' into swastika/chore/..." | Re-trigger Greptile |
| - **Solution.** What your change does. | ||
| - **How to Test.** The sim, replay, or hardware steps a reviewer can follow. | ||
| - **AI assistance.** What was AI-assisted, as required by the [AI policy](AI_POLICY.md). | ||
| - **CLA checkbox.** Confirm you have signed. | ||
|
|
There was a problem hiding this comment.
AI assistance section missing from the actual PR template
CONTRIBUTING.md tells contributors to fill in an "AI assistance" section when opening a pull request, but .github/pull_request_template.md has no such section — it only contains Problem, Solution, How to Test, and the CLA checkbox. Because the template never prompts for AI disclosure, contributors will simply skip it, making the AI_POLICY.md disclosure requirement unenforceable in practice. The pull_request_template.md needs an "AI assistance" section added to close this gap.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
|
|
||
| --- | ||
|
|
||
| Thanks for helping build the operating system for physical space. We are glad you are here. No newline at end of file |
There was a problem hiding this comment.
Same trailing-newline fix for
CONTRIBUTING.md.
| Thanks for helping build the operating system for physical space. We are glad you are here. | |
| Thanks for helping build the operating system for physical space. We are glad you are here. |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
|
|
||
| Issues, discussions, and pull requests are where your work meets a maintainer's calendar. Low-effort or unreviewed submissions, especially confident-looking code or prose that nobody can explain, move the whole job of verification onto a small team and slow everyone else down. | ||
|
|
||
| This policy is about quality and safety on real systems, not about banning useful tools. No newline at end of file |
There was a problem hiding this comment.
Missing trailing newline at end of file — the POSIX standard for text files.
| This policy is about quality and safety on real systems, not about banning useful tools. | |
| This policy is about quality and safety on real systems, not about banning useful tools. |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Problem
the contributing guide and our ai policy is missing.
Solution
added contributing and ai policy guide to make things easier and clearer for us (maintainers) as well as contributors.