Skip to content

chore: add contribution baseline (AGENTS.md, opt-in AI-assist hook) #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
tnunamak wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

chore: add contribution baseline (AGENTS.md, opt-in AI-assist hook) #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/hooks/prepare-commit-msg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/sh
# Opt-in AI-assistance trailer. Off unless PDPP_AI_ASSISTED=1.
# Install: git config core.hooksPath .github/hooks

[ "${PDPP_AI_ASSISTED:-0}" = "1" ] || exit 0
MSG_FILE="$1"
grep -qi '^Assisted-by:' "$MSG_FILE" && exit 0
case "$2" in merge|squash) exit 0 ;; esac
printf '\nAssisted-by: AI\n' >> "$MSG_FILE"
11 changes: 11 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,14 @@ Use skills only when the task matches; explore the code first.
- Patch-first debugging: invoke patch-first-debugging for normal bug fixes, regressions, or surgical code changes where the main need is narrow scope, minimal diffs, and targeted verification.
- Test-fix harnesses: invoke test-fix-loop when the user wants a constrained failing-test repair loop, minimal-patch harness, or automated test-fix workflow; use this for loop orchestration, not ordinary bug fixing.
- Committing: invoke committing skill only when user explicitly asks to commit.

### Contributing

Policy: [CONTRIBUTING.md](./CONTRIBUTING.md).

- Sign off commits (`git commit -s`); unsigned are blocked.
- Disclose AI assistance: `Assisted-by: AI` trailer (opt-in hook: `PDPP_AI_ASSISTED=1`).
- Prose (PRs, issues, comments): technical, no filler, no emojis. What changed and why, briefly.
- Reject verbose summaries. Concise unless the change is a refactor, break, or architecture.
- Claims about the code need a file path or a reason.
- One change per PR. Run the repo's checks first.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,11 @@

By submitting a contribution (including code, documentation, or other materials), you agree that your contribution is licensed under the Apache License, Version 2.0, as described in the LICENSE file.
You represent that you have the right to submit the contribution and that it does not infringe third-party rights.

## AI assistance

Building with AI is welcome. If AI helped meaningfully, add an `Assisted-by: AI`
trailer to the commit so reviewers can calibrate their scrutiny; a local hook can
add it for you (`.github/hooks/prepare-commit-msg`). It is vendor-neutral and sits
alongside your DCO sign-off. We review contributions on whether they are good, not
how they were made.