docs: add CONTRIBUTING.md#407
Conversation
…R template - Move from docs/contributing/contributing.md to repo root CONTRIBUTING.md - Replace full setup instructions with link to README - Replace PR checklists with link to PR template - Replace hook enumeration with link to .pre-commit-config.yaml - Remove troubleshooting table and maintainer tags - Add issue-first workflow and 'read discussion' step - Keep only the two essential verify commands Addresses feedback from @joeloskarsson on mllam#407
|
@ANANYA542 I saw that you are expanding our work on this PR here. Note that autodoc is already tackled by #322. So I would prefer if this PR here could focus on the CONTRIBUTING.md file. And work closely together with #516 to reduce duplicated information that's hard to maintain. Could you reduce the scope of this PR here and update the title to make it clearer? |
…R template - Move from docs/contributing/contributing.md to repo root CONTRIBUTING.md - Replace full setup instructions with link to README - Replace PR checklists with link to PR template - Replace hook enumeration with link to .pre-commit-config.yaml - Remove troubleshooting table and maintainer tags - Add issue-first workflow and 'read discussion' step - Keep only the two essential verify commands Addresses feedback from @joeloskarsson on mllam#407
48462b1 to
cecbf9f
Compare
|
@sadamov Thanks for the review! I have dropped the Jupyter Book commits since #322 already tackles autodoc, and reduced the scope to focus solely on CONTRIBUTING.md at the root. This is ready and provides the complete contribution guidelines so that the subsequent #516 PR can heavily trim AGENTS.md to just link to this file. I updated the PR title as well. |
There was a problem hiding this comment.
Thanks a lot for your patience with the review. This past month has been crazy. The approach is good: concise, defers to existing docs rather than duplicating them, and links to authoritative sources.
Required changes
1. Missing CHANGELOG entry
The author checklist item is unchecked and no entry has been added to CHANGELOG.md. Required per project standards. Belongs under ### maintenance in the [unreleased] section, e.g.:
- Add `CONTRIBUTING.md` contributor guide [\#407](https://github.com/mllam/neural-lam/pull/407) @ANANYA542
2. Stale PR description
The description claims the file contains "all 13 pre-commit hooks documented" and "a troubleshooting table" — neither exists in the final file. Please update the PR description to match what was actually committed.
Follow-up items
AGENTS.md deduplication
AGENTS.md contains rules now fully covered by CONTRIBUTING.md:
- PR rule 5: "Run pre-commit hooks locally"
- PR rule 6: "Testing Mandate"
### Changelogsection
These should be stripped and replaced with a pointer to CONTRIBUTING.md at the top of ## Rules
README.md deduplication
README.md lines 570–578 ("Development and Contributing") now duplicates CONTRIBUTING.md.
| ## Getting help | ||
|
|
||
| - Join the [mllam Slack workspace]( https://join.slack.com/t/ml-lam/shared_invite/zt-3jyw20n4g-ESRxMPPSijiZ2ZA6Nh8XhA) | ||
| - [Open a GitHub issue](https://github.com/mllam/neural-lam/issues) |
There was a problem hiding this comment.
Replace with short URL that is stable:
- Join the
[mllam Slack workspace](kutt.to/mllam)
Describe your changes
Adds docs/contributing/contributing.md — a concise contributor guide that walks a new contributor through the full workflow from fork to merged PR.
Covers: ways to contribute, environment setup (referencing existing README install instructions rather than duplicating them), all 13 pre-commit hooks documented, code standards, how to run the test suite locally using the exact CI commands, PR checklist, review process with CHANGELOG format, and a troubleshooting table.
The goal is to give new contributors a single document to reference rather than piecing together information from the README, PR template, and CI config separately. Redundant sections have been removed and replaced with direct references to existing docs.
Issue Link
fixes #406
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee