[AAP-38577] Docs: Add Contributors Guide #62
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
art-tapin
changed the title
5 tasks
art-tapin
requested review from
msmagnanijr,
MilanPospisil,
ShaiahWren and
dhaustein
ShaiahWren
reviewed
Feb 5, 2025
ShaiahWren
reviewed
Feb 5, 2025
ShaiahWren
reviewed
Feb 5, 2025
ShaiahWren
approved these changes
Feb 5, 2025
dhaustein
approved these changes
Feb 7, 2025
There was a problem hiding this comment.
Left a few comments, but LGTM overall. This probably took some time to write. Good job!
CONTRIBUTING.md or CONTRIBUTING.rst depending on the markup format. See repos for pytest or numpy for example.
-- Squashed -- [AAP-38577] Clarify sections 2, 4, 5 & 6 following reviewers suggestions - Added direct links to pre-commit setup in developer_setup.md. - Clarified pre-commit enforcement and removed redundant manual checks. - Explicitly referenced /.pre-commit-config.yaml for configuration details. - Strengthened guidance on downstream documentation, ensuring internal details remain private. - Improved wording for code quality and formatting requirements in PR submissions. [AAP-38577] Improve Contributor Guide: commit messages, branch naming, and dependencies Ref: [AAP-38577] [AAP-38577] Add Contributors Guide to metrics-utility - Introduced a contributor_guide.md under docs/contributing/ - Documents the forking workflow, PR requirements, and code style - Provides references to developer_setup.md and pyproject.toml - Aligns with existing repository conventions Ref: [AAP-38577]
art-tapin
force-pushed
the
docs-contributor_guide
branch
from
5cd52d5 to
4587379
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a Contributor’s Guide to
metrics-utility, outlining contribution guidelines, the forking workflow, and repository conventions. It ensures clarity for both internal and external contributors.rufflinter settings frompyproject.toml.developer_setup.md) for environment setup.Testing
No code changes—documentation only.
Required Actions
Self-Review Checklist
Notes:
Related to #61
AAP-38577