Skip to content

Commit a77313b

Browse files
authored
fix/contributing guide ai assistance (#2328)
* add contributors ai disclosure policy * add disclosure and pr template
1 parent 980b2fb commit a77313b

File tree

2 files changed

+67
-0
lines changed

2 files changed

+67
-0
lines changed

.github/pull_request_template.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
### 🧠 AI Assistance Disclosure Policy
2+
3+
> [!IMPORTANT]
4+
> Inspired by [ghostty](https://github.com/ghostty-org/ghostty/blob/main/CONTRIBUTING.md#ai-assistance-notice).
5+
> If you used **any AI assistance** while contributing to Digger, you must disclose it in this PR.
6+
7+
---
8+
9+
#### ✅ AI Disclosure Checklist
10+
11+
- [ ] I understand that all AI assistance must be disclosed.
12+
- [ ] I did **not** use AI tools in this contribution.
13+
- [ ] I used AI tools and have disclosed details below.
14+
15+
**Details (if applicable):**
16+
> _Example: Used ChatGPT to help with doc phrasing._
17+
> _Example: Code generated by Copilot; reviewed and verified manually._
18+
19+
---
20+
21+
#### 💡 Notes
22+
23+
- Trivial auto-completions (single words, short phrases) don’t need disclosure.
24+
- Contributors must understand and take responsibility for any AI-assisted code.
25+
- Failure to disclose is considered disrespectful to maintainers and may delay review.

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,48 @@ and we would be happy to set you up.
2323
Digger is an open source terraform cloud alternative. We believe that open source software is important, and we welcome contributions from anyone who is interested in making our platform better.
2424
This document is intended to be a guide for people who want to contribute to Digger. We appreciate all contributions, no matter how big or small.
2525

26+
## AI Assistance Notice
27+
28+
> [!IMPORTANT]
29+
>
30+
> We have an AI assistance policy inspired by
31+
> [ghostty](https://github.com/ghostty-org/ghostty/blob/main/CONTRIBUTING.md#ai-assistance-notice).
32+
> We copied the same policy with a few modifications below
33+
> If you are using **any kind of AI assistance** to contribute to Digger,
34+
> it must be disclosed in the pull request.
35+
36+
If you are using any kind of AI assistance while contributing to Digger,
37+
**this must be disclosed in the pull request**, along with the extent to
38+
which AI assistance was used (e.g. docs only vs. code generation).
39+
If PR responses are being generated by an AI, disclose that as well.
40+
As a small exception, trivial tab-completion doesn't need to be disclosed,
41+
so long as it is limited to single keywords or short phrases.
42+
43+
An example disclosure:
44+
45+
> This PR was written primarily by Claude Code.
46+
47+
Or a more detailed disclosure:
48+
49+
> I consulted ChatGPT to understand the codebase but the solution
50+
> was fully authored manually by myself.
51+
52+
Failure to disclose this is first and foremost rude to the human operators
53+
on the other end of the pull request, but it also makes it difficult to
54+
determine how much scrutiny to apply to the contribution.
55+
56+
In a perfect world, AI assistance would produce equal or higher quality
57+
work than any human. That isn't the world we live in today, and in most cases
58+
it's generating slop. I say this despite being a fan of and using them
59+
successfully myself (with heavy supervision)!
60+
61+
When using AI assistance, we expect contributors to understand the code
62+
that is produced and be able to answer critical questions about it. It
63+
isn't a maintainers job to review a PR so broken that it requires
64+
significant rework to be acceptable.
65+
66+
Please be respectful to maintainers and disclose AI assistance.
67+
2668
## How to contribute
2769

2870
**If you are considering using digger within your organisation

0 commit comments

Comments
 (0)