Skip to content

Update AI guidance in CONTRIBUTING.md - #3910

Open
ann0see wants to merge 1 commit into
jamulussoftware:mainfrom
ann0see:updateContributing
Open

Update AI guidance in CONTRIBUTING.md#3910
ann0see wants to merge 1 commit into
jamulussoftware:mainfrom
ann0see:updateContributing

Conversation

@ann0see

@ann0see ann0see commented Aug 17, 2026

Copy link
Copy Markdown
Member

Short description of changes

Updates CONTRIBUTING.md with some AI usage guidance.

CHANGELOG: Add AI guidance for contributing documentation
Context: Fixes an issue?

Related to: https://github.com/orgs/jamulussoftware/discussions/3822

Does this change need documentation? What needs to be documented and how?

It is documentation...

Status of this Pull Request

Ready for review

What is missing until this pull request can be merged?

Review of these proposed changes. New changes may be added later in a separate PR.

Checklist

@ann0see
ann0see marked this pull request as ready for review August 17, 2026 19:17
@ann0see ann0see added this to the Release 4.0.0 milestone Aug 17, 2026
@ann0see

ann0see commented Aug 17, 2026

Copy link
Copy Markdown
Member Author

Tangentially related — while reviewing CONTRIBUTING.md I noticed some human-side gaps that predate the AI discussion. Not sure if they fit here or should be separate:

  1. "Discuss first" has no consequence (line 8). People show up with finished PRs for unapproved features. Should say those may be closed.
  2. Testing is too vague (line 101-103). "Run a local test" doesn't say what evidence is needed or that new behaviour should have a test.
  3. Ownership doesn't require understanding (line 107). "Answering all questions" implies it, but doesn't say it. Also: stale PRs should be closable.
  4. AI mention (line 10). Could be clearer that AI contributions are welcome and held to the same standards.
  5. PR template asks "what" but not "why".

May be out of scope for this PR. Just noting.

🤖 Used AI: opencode/big-pickle, opencode

@ann0see

ann0see commented Aug 17, 2026

Copy link
Copy Markdown
Member Author

"Discuss first" has no consequence (line 8). People show up with finished PRs for unapproved features. Should say those may be closed.

Fair point. We usually don't do this though.

Testing is too vague (line 101-103). "Run a local test" doesn't say what evidence is needed or that new behaviour should have a test.

Testing is not specified as it depends on the thing that changes. But agree, we could tighten it.

Ownership doesn't require understanding (line 107). "Answering all questions" implies it, but doesn't say it. Also: stale PRs should be closable.

What? I think that's clear enough. no?

AI mention (line 10). Could be clearer that AI contributions are welcome and held to the same standards.

No. I think it's fine as is.

PR template asks "what" but not "why".

Yes, we could change this...

@ann0see

This comment was marked as outdated.

@ann0see

ann0see commented Aug 17, 2026

Copy link
Copy Markdown
Member Author

@ann0see sorry for the noise. You were right on points 1, 3, and 4 — I should have re-read more carefully before commenting.

On testing: fair that it depends on the change. Maybe just "attach evidence of testing (logs, output, screenshots)" as a one-liner would be enough without prescribing what kind of test.

On the PR template: sounds like we agree there.

🤖 Used AI: opencode/big-pickle, opencode

@ann0see

ann0see commented Aug 17, 2026

Copy link
Copy Markdown
Member Author

The PR template is out of scope here though. Let me add the other suggestion...

@ann0see
ann0see force-pushed the updateContributing branch from c9ab2bc to 27866dd Compare August 17, 2026 19:47
@ann0see ann0see added this to Tracking Aug 17, 2026
@ann0see ann0see moved this to Waiting on Team in Tracking Aug 17, 2026
@mcfnord

mcfnord commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

You are... discussing with your AI ? Could you and your AI hash out your differences and then share with the group? And your AI is sorry for the noise? Or you are? AI isn't sorry if AI just does it again. Fluff words? And you're debating with your AI?

I don't post anything until I suspect the draft is useful and as right as I can make it.

But perhaps I'll follow your lead and make my AI respond, and then I'll respond to that, and then let it pretend to be a conciliatory human, and so on and so on and so on...

WALL-O-TEXT MARATHON SUPREME!

@ann0see

ann0see commented Aug 17, 2026

Copy link
Copy Markdown
Member Author

I wanted to show the review comments. So it's publicly visible what happened. The workflow by dtinth is basically comparable. Though I don't have the setup like he has yet. We can discuss if that's ok or not.

Comment thread CONTRIBUTING.md

### Using AI

Use AI responsibly: If you choose to use AI, judge its outputs and review it for any kind of issues before submitting. Do not answer every comment with AI. Judge if AI use is beneficial for your usecase.

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.

🤖 AI: The AI-specific expectations in this PR — strong testing proof, stating what isn't understood, closing low-effort contributions — can only be applied when reviewers know AI was involved, and nothing in the text asks contributors to say so. One sentence codifies what was already requested on #3649: "Please make clear when your AI speaks!"

Suggested change
Use AI responsibly: If you choose to use AI, judge its outputs and review it for any kind of issues before submitting. Do not answer every comment with AI. Judge if AI use is beneficial for your usecase.
Use AI responsibly: If you choose to use AI, judge its outputs and review them for any kind of issues before submitting. State in your issue or Pull Request description whether and how AI was used. Do not answer every comment with AI. Judge if AI use is beneficial for your usecase.

Comment thread CONTRIBUTING.md
### Testing

To check that there are no errors, please run a local (build/feature) test. Keep an eye on the CI checks for quality or compile issues after opening a pull request and fix them as needed. You can also test the build on your repository by naming your branch `autobuild/<branchName>` which will start the building process on your repo.
To check that there are no errors, please run a local (build/feature) test. It is good practice to briefly explain what and how you tested your work - for AI contributions specifically, you should provide strong testing and proof. This may include logs, screenshots, small testing scripts or similar depending on your change.

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.

🤖 AI: This restates the AGENTS.md evidence rule ("Attach test evidence (logs/output) to the PR — never just assert something works") in a weaker, AI-only form, and it pulls against "AI assisted contributions must follow the same standards as every other contribution" in the section above. Stating the expectation once, for every contribution, removes both the divergent copy and the tension:

Suggested change
To check that there are no errors, please run a local (build/feature) test. It is good practice to briefly explain what and how you tested your work - for AI contributions specifically, you should provide strong testing and proof. This may include logs, screenshots, small testing scripts or similar depending on your change.
To check that there are no errors, please run a local (build/feature) test. Briefly explain in the PR what and how you tested your work and attach evidence - logs, screenshots, small testing scripts or similar depending on your change.

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

Labels

None yet

Projects

Status: Waiting on Team

Development

Successfully merging this pull request may close these issues.

2 participants