Skip to content

Commit e15309a

Browse files
authored
Merge pull request #1060 from dev-markdavid/issues-984-989-995-1008
Issues 984 989 995 1008
2 parents fc1ab15 + eef4c18 commit e15309a

8 files changed

Lines changed: 971 additions & 427 deletions

File tree

CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Contributing
2+
3+
## Branch Naming
4+
5+
Branches follow this pattern:
6+
<your-username>/<type>/<short-description>
7+
8+
`<type>` is one of:
9+
10+
- `feat/` — new feature
11+
- `fix/` — bug fix
12+
- `chore/` — maintenance, tooling, dependencies
13+
- `docs/` — documentation only
14+
- `refactor/` — code change that isn't a fix or a feature
15+
- `test/` — adding or fixing tests
16+
17+
If your branch addresses one or more issues, include the issue number(s) in the description:
18+
feat/issues-986-987-988-frontend-accessibility
19+
20+
fix/issue-966-fee-calculation-overflow
21+
22+
## Commit Message Format
23+
24+
Commits follow [Conventional Commits](https://www.conventionalcommits.org/):
25+
<type>(<scope>): <description>
26+
27+
`<type>` must be one of:
28+
29+
- `feat` — new feature
30+
- `fix` — bug fix
31+
- `docs` — documentation only
32+
- `style` — formatting, no code meaning change
33+
- `refactor` — code change that isn't a fix or a feature
34+
- `perf` — performance improvement
35+
- `test` — adding or fixing tests
36+
- `build` — build system or dependencies
37+
- `ci` — CI configuration
38+
- `chore` — anything else maintenance-related
39+
- `security` — security fix
40+
41+
`<scope>` is optional and usually the area touched, e.g. `frontend`, `contract`.
42+
43+
Reference issue numbers in the description when relevant:
44+
feat(frontend): add CSV export button to AuditTable
45+
46+
fix(contract): integer overflow in fee calculation for large deposits #966
47+
48+
docs: add CONTRIBUTING.md with branch and commit conventions
49+
50+
A breaking change is marked with `!` after the type/scope:
51+
feat(contract)!: change withdrawal function signature
52+
53+
## Pull Request Checklist
54+
55+
Before opening a PR:
56+
57+
- [ ] Branch name follows the format above
58+
- [ ] Commit messages follow the format above
59+
- [ ] PR description links the issue(s) it closes (`Closes #123`)
60+
- [ ] `npx lint-staged` runs clean (this also runs automatically on commit)
61+
- [ ] Tests pass locally
62+
- [ ] No unrelated files included in the diff

0 commit comments

Comments
 (0)