Update AI guidance in CONTRIBUTING.md - #3910
Conversation
|
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:
May be out of scope for this PR. Just noting.
|
Fair point. We usually don't do this though.
Testing is not specified as it depends on the thing that changes. But agree, we could tighten it.
What? I think that's clear enough. no?
No. I think it's fine as is.
Yes, we could change this... |
This comment was marked as outdated.
This comment was marked as outdated.
|
@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.
|
|
The PR template is out of scope here though. Let me add the other suggestion... |
c9ab2bc to
27866dd
Compare
|
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! |
|
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. |
Co-authored-by: Peter L Jones <pljones@users.noreply.github.com>
Co-authored-by: John Dempsey <1750243+mcfnord@users.noreply.github.com>
| ### Ownership | ||
|
|
||
| The submitter of an Issue or a PR is responsible for its care and feeding, answering all questions directed at them, and making agreed changes if necessary. | ||
| The submitter of an issue or a Pull Request is responsible for its care and feeding (this also holds for AI contributions), answering all questions directed at them, and making agreed changes if necessary. In case you use AI and do not understand some outputs, clearly state this and ask - either AI or humans. |
There was a problem hiding this comment.
Issue is a proper noun as it refers to Github-specific jargon. It's not the generic term "issue" used in everyday speech.
| The submitter of an issue or a Pull Request is responsible for its care and feeding (this also holds for AI contributions), answering all questions directed at them, and making agreed changes if necessary. In case you use AI and do not understand some outputs, clearly state this and ask - either AI or humans. | |
| The submitter of an Issue or a Pull Request is responsible for its care and feeding (this also holds for contributions that were assisted by AI), answering all questions directed at them, and making agreed changes if necessary. In case you use AI and do not understand some outputs, clarify before submission if possible (for example, by asking the project team or an AI agent) or else clearly state this. |
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