Skip to content

Commit b5b715c

Browse files
committed
chore: add CONTRIBUTING.md
1 parent a8ac392 commit b5b715c

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing to Quint Code
2+
3+
## Workflow
4+
5+
1. **Create an issue first** — Open an issue with the `proposal` label. Include:
6+
- Rationale — either FPF methodology alignment or UX improvement (feature request)
7+
- Question or problem statement
8+
- Proposed solution
9+
10+
2. **Wait for agreement** — Do not create a PR until the proposal has been discussed and agreed upon in the issue.
11+
12+
3. **Check for existing work** — Before starting, verify no one else has picked up the same issue. Comment on the issue to claim it.
13+
14+
4. **Create PR to `dev` branch** — When ready, open a pull request targeting `dev`, not `main`. Link the original issue.
15+
16+
5. **Update the changelog** — Add your changes to `CHANGELOG.md` under the `[Unreleased]` section.
17+
18+
## Want to Help but No Proposal?
19+
20+
Check existing issues labeled `bug`, `documentation`, or `help wanted`. Leave a comment to express interest and wait for approval before starting work.
21+
22+
## Summary
23+
24+
```
25+
Issue (proposal label) → Agreement → Claim issue → PR to dev → Update changelog
26+
```

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ See [docs/fpf-engine.md](docs/fpf-engine.md) for the full breakdown.
9999

100100
- [FPF Engine Details](docs/fpf-engine.md) — ADI cycle, commands, when to use
101101
- [Architecture](docs/architecture.md) — Internals, knowledge levels, Transformer Mandate
102+
- [Contributing](CONTRIBUTING.md) — How to contribute
102103

103104
## License
104105

0 commit comments

Comments
 (0)