Skip to content

add gitHub community files for contributors and AI-assisted development#2347

Open
swstica wants to merge 5 commits into
mainfrom
swastika/chore/contribution-and-ai-policy
Open

add gitHub community files for contributors and AI-assisted development#2347
swstica wants to merge 5 commits into
mainfrom
swastika/chore/contribution-and-ai-policy

Conversation

@swstica
Copy link
Copy Markdown
Contributor

@swstica swstica commented Jun 3, 2026

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.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Jun 3, 2026

Greptile Summary

This PR adds two new community documentation files — CONTRIBUTING.md and AI_POLICY.md — to establish contribution guidelines and an AI usage policy for the dimOS project.

  • CONTRIBUTING.md covers the full contribution lifecycle: the critical safety rule, AI disclosure requirements, issue/discussion triage, PR workflow, the CLA, and a code of conduct. The table of contents contains one broken anchor (#how-to), and the file's claim that the AI policy "applies to everyone" contradicts the maintainer exemption in AI_POLICY.md.
  • AI_POLICY.md defines disclosure obligations, the human-in-the-loop requirement for hardware-touching changes, and the explicit distinction between using dimOS (permissive) and contributing to it (human-reviewed).

Confidence Score: 5/5

Documentation-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

Filename Overview
CONTRIBUTING.md New contributor guide covering the contribution process, safety requirements, issue/discussion triage, and PR workflow. Contains a broken table-of-contents anchor (#how-to) and a scope inconsistency with AI_POLICY.md regarding who the AI disclosure rules apply to.
AI_POLICY.md New AI usage policy document; clearly scopes hardware-safety obligations, disclosure requirements, and the distinction between using vs. contributing to dimOS. Maintainer exemption is explicit but conflicts with CONTRIBUTING.md's 'applies to everyone' phrasing.

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
Loading

Reviews (5): Last reviewed commit: "Merge branch 'main' into swastika/chore/..." | Re-trigger Greptile

Comment thread CONTRIBUTING.md Outdated
Comment on lines +87 to +91
- **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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 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!

Comment thread CONTRIBUTING.md Outdated

---

Thanks for helping build the operating system for physical space. We are glad you are here. No newline at end of file
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Same trailing-newline fix for CONTRIBUTING.md.

Suggested change
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!

Comment thread AI_POLICY.md Outdated

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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Missing trailing newline at end of file — the POSIX standard for text files.

Suggested change
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
Copy link
Copy Markdown

codecov Bot commented Jun 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant