Skip to content

Conversation

@janhoy
Copy link
Contributor

@janhoy janhoy commented Dec 12, 2025

These are my suggested edits. See also dev-list discussion with subject "[DISCUSS] AI assisted contributions"

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 12, 2025
Copy link
Contributor

@epugh epugh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Copy link
Contributor

@dsmiley dsmiley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice. Glad this is short.

@janhoy
Copy link
Contributor Author

janhoy commented Jan 16, 2026

I came across https://vibe-coding-manifesto.com from another ASF mailing list, which goes more in depth on many of these topics. Perhaps worth linking to, especially for non-devs who want to contribute.

Would it be an idea to start a PROMPTING.md file in the repo, to encode the key peculiarities of our project, such as tidy, precommit etc?

@rahulgoswami
Copy link
Contributor

rahulgoswami commented Jan 18, 2026

Would it be an idea to start a PROMPTING.md file in the repo, to encode the key peculiarities of our project, such as tidy, precommit etc?

I can think of both pros and cons of doing this.
Pros: Could help provide a consistent project view across agents. "/init" in either OpenAI Codex or Claude Code will generate a solid first draft which could be iterated upon. I tried both the agents, and fwiw CLAUDE.md was much more comprehensive. Let me know if you'd like me to share it.

Cons: Agents have gotten good at generating this themselves. Do we want to maintain it?

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

Labels

documentation Improvements or additions to documentation no-changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants