docs: add CONTRIBUTING.md and update README contributing section#54
Merged
docs: add CONTRIBUTING.md and update README contributing section#54
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds a centralized contribution guide for ferrish and updates the README to link to it, aligning contribution expectations with the project’s workflow and principles.
Changes:
- Add
.github/CONTRIBUTING.mdcovering branch naming, PR workflow, tests/lint requirements, and core principles. - Update
README.md“Contributing” section to point to the new contributing guide instead of duplicating guidance.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Replaces inline contribution guidance with a link to the canonical contributing document. |
| .github/CONTRIBUTING.md | Introduces contribution standards (branch/PR workflow) and documents test/lint expectations and principles. |
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or 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
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
Closes #11.
Adds
.github/CONTRIBUTING.mdwith branching conventions, PR workflow, test and lint requirements, and project principles. Updates the README contributing section to link to it rather than duplicating content.Type of change
Test checklist
cargo testpassescargo clippy --all-targets --all-features -- -D warningspasses