docs: add comprehensive contributing guide #847
Conversation
LalatenduMohanty
force-pushed
the
coding_best_practices_guide
branch
from
7fdc5b0 to
1bee758
Compare
|
@dhellmann @tiran It would be good if you both can review this. |
rd4398
left a comment
rd4398
left a comment
There was a problem hiding this comment.
This looks okay! I will leave it to Doug / Christian for approval
LalatenduMohanty
force-pushed
the
coding_best_practices_guide
branch
4 times, most recently
from
1f51f62 to
fb32752
Compare
EmilienM
left a comment
EmilienM
left a comment
There was a problem hiding this comment.
good word, a bit lengthy but we can adjust later if it's causing too much troubles to the tools.
|
@dhellmann @tiran we should merge this PR. Else let me know what I should change. But an updated AGENTS.MD and CONTRIBUTING.md would helps AI agents to write better code. |
LalatenduMohanty
force-pushed
the
coding_best_practices_guide
branch
from
fb32752 to
3af0baf
Compare
|
The recent push has import guidelines |
LalatenduMohanty
force-pushed
the
coding_best_practices_guide
branch
3 times, most recently
from
a01650d to
2ee31d0
Compare
Create CONTRIBUTING.md with detailed coding standards, design patterns, testing guidelines, and commit conventions. Transform AGENTS.md from a basic commit message guide into a comprehensive AI agent reference following agentsmd.io and Anthropic Claude Code best practices. Both files establish complementary documentation: CONTRIBUTING.md for human contributors, AGENTS.md for AI coding assistants, creating a single source of truth for project standards. Signed-off-by: Lalatendu Mohanty <lmohanty@redhat.com>
LalatenduMohanty
force-pushed
the
coding_best_practices_guide
branch
from
2ee31d0 to
7ed659a
Compare
|
@dhellmann I have addressed your comments and improved some texts. PTAL |
dhellmann
left a comment
dhellmann
left a comment
There was a problem hiding this comment.
I'll approve this as it is. I have a couple of suggestions for further refinement.
| pipx install hatch # recommended | ||
| ``` | ||
|
|
||
| ### Initial Setup |
There was a problem hiding this comment.
I feel like this section and the next could be left out. It's a workflow, but it's not the one I use, so it's weird to express it as though it's required.
There was a problem hiding this comment.
@dhellmann I am fine with removing it. I will send another PR to remove it.
| wait_time = min(2**attempt + random.uniform(0, 1), max_backoff) | ||
| ``` | ||
|
|
||
| ### Logging |
There was a problem hiding this comment.
There are more detailed suggestions in https://fromager.readthedocs.io/en/latest/develop.html#logging
I wonder if we should move more of that page into this doc? And link to this doc from there? Or vice versa?
There was a problem hiding this comment.
yeah, we can do that.
4 participants
Create CONTRIBUTING.md with detailed coding standards, design patterns,
testing guidelines, and commit conventions. Transform AGENTS.md from a
basic commit message guide into a comprehensive AI agent reference
following agentsmd.io and Anthropic Claude Code best practices.
Both files establish complementary documentation: CONTRIBUTING.md for
human contributors, AGENTS.md for AI coding assistants, creating a
single source of truth for project standards.
Fixes : #854