Skip to content

Commit afa6457

Browse files
codexByron
andcommitted
Clarify and extent contribution guidelines around AI usage
Co-authored-by: Sebastian Thiel <sebastian.thiel@icloud.com>
1 parent 7a426e7 commit afa6457

3 files changed

Lines changed: 26 additions & 4 deletions

File tree

COLLABORATING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,15 @@
1616
- …and you _do know_ the cause, please fix it immediately. If necessary by reverting the offending commit until a more durable fix is possible.
1717
- …and you _do not know_ the cause, please open a PR to invite collaborators for their input. This is to avoid multiple collaborators
1818
trying to fix the issue independently, causing merge-conflicts and confusion. We use this PR as synchronization primitive.
19+
- **please disclose AI assistance when collaborating**
20+
- if AI edits files for you, disclose it in the PR description and commit metadata, preferably with an AI author
21+
such as `$agent $version <ai-agent@example.invalid>` or a `Co-authored-by: <agent-identity>` trailer.
22+
- agents operating through a person's GitHub account must identify themselves in comments, for example with phrases
23+
like `AI agent on behalf of <person>: ...`.
24+
- fully AI-generated PR or issue comments must be disclosed. Undisclosed AI-generated comments may lead to the PR or
25+
issue being closed.
26+
- AI-assisted proofreading or wording polish does not need disclosure, but it is still courteous to mention it when
27+
the AI materially influenced the final text.
1928
- **for crates _you own_**
2029
- feel free to make any kind of changes to it, including major ones.
2130
- please use `cargo smart-release` for publishing to crates.io as it will handle dependencies properly.

CONTRIBUTING.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
1-
### Please disclose the use AI…
1+
### Please disclose the use of AI
22

3-
…if it's editing files for you please let us know in the PR comment _or preferably_ using
4-
`Co-authored-by: <agent-identity>` message trailers.
3+
If AI edits files for you, disclose it in the PR description and commit metadata. Prefer making the
4+
agent identity part of the commit, for example by using an AI *author* such as `$agent $version <ai-agent@example.invalid>`
5+
or a *co-author* via `Co-authored-by: <agent-identity>` trailer.
6+
Recent commits in this repository use that pattern, often with a *human* `Co-authored-by` trailer when a person also contributed directly.
7+
8+
Agents operating through a person's GitHub account must identify themselves. For example, comments
9+
posted by an agent should say so directly with phrases like `AI agent on behalf of <person>: ...`.
10+
11+
Fully AI-generated comments on PRs or issues must also be disclosed. Undisclosed AI-generated
12+
comments may lead to the PR or issue being closed.
13+
14+
AI-assisted proofreading or wording polish does not need disclosure, but it is still courteous to
15+
mention it when the AI materially influenced the final text.
516

617
For everything else, please have a look at the respective section in the [README] file.
718

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,8 +348,10 @@ We recommend running `just test` during the development process to assure CI is
348348
A backlog for work ready to be picked up is [available in the Project's Kanban board][project-board], which contains instructions on how
349349
to pick a task. If it's empty or you have other questions, feel free to [start a discussion][discussions] or reach out to @Byron [privately][keybase].
350350

351-
For additional details, also take a look at the [collaboration guide].
351+
For additional details, also take a look at the [collaboration guide]. If AI participates in a contribution, please
352+
follow the [AI disclosure requirements]. "Full-auto" contributions without a human on the other end may be closed unceremoniously.
352353

354+
[AI disclosure requirements]: https://github.com/GitoxideLabs/gitoxide/blob/main/CONTRIBUTING.md#please-disclose-the-use-of-ai
353355
[collaboration guide]: https://github.com/GitoxideLabs/gitoxide/blob/main/COLLABORATING.md
354356
[project-board]: https://github.com/GitoxideLabs/gitoxide/projects
355357
[discussions]: https://github.com/GitoxideLabs/gitoxide/discussions

0 commit comments

Comments
 (0)