Skip to content

docs: add CONTRIBUTING.md and update README contributing section #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cdprice02 merged 2 commits into from
Apr 8, 2026
+42 −9
Merged

docs: add CONTRIBUTING.md and update README contributing section #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
65c4797
docs: add CONTRIBUTING.md and update README contributing section
Apr 8, 2026
b265cc3
fix: address review comment — use full clippy command in Lint section
Apr 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Contributing to ferrish

## Branch Naming

Branches must follow the pattern `type/issue-N-short-description`:

- `fix/issue-52-readme-banners`
- `refactor/issue-12-type-command`
- `feat/issue-7-pipeline-support`

Valid types: `feat`, `fix`, `refactor`, `docs`, `chore`, `test`.

## PR Workflow

- Squash merge only; each PR addresses one concern.
- Reference the issue in the PR body with `closes #N`.
- Keep diffs minimal and focused. Avoid unrelated cleanup in the same PR.

## Tests

All changes must pass:

```bash
cargo test
cargo clippy --all-targets --all-features -- -D warnings
```

Prefer integration tests via the `ShellTest` harness in `tests/harness.rs` for anything user-visible. Unit tests are appropriate for internal logic that is difficult to exercise from the outside.

## Lint

`cargo clippy --all-targets --all-features -- -D warnings` is enforced by CI. No warnings are allowed. Fix warnings before opening a PR rather than suppressing them with `#[allow(...)]` unless suppression is genuinely justified.

## Core Principles

These principles guide all design and implementation decisions:

- **Correctness over performance** — when a trade-off exists, correctness wins.
- **Safety by default** — avoid footguns, undefined behavior, and surprising side effects.
- **Explicit over implicit** — favor clear, readable behavior over clever but opaque magic.
- **Predictable semantics** — the same input should always produce the same result.
10 changes: 1 addition & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,15 +66,7 @@ Compatibility may be explored selectively, but only when it aligns with ferrish

## Contributing

ferrish is in early development, and contributions are welcome once the core architecture begins to stabilize.

If you’re interested in contributing:

* Open an issue to discuss ideas before starting major work
* Keep changes focused and aligned with ferrish’s core principles
* Prefer clarity and correctness over clever optimizations

More detailed contribution guidelines may be added as the project matures.
See [CONTRIBUTING.md](.github/CONTRIBUTING.md) for branch conventions, PR workflow, test requirements, and project principles.

---

Expand Down
Loading