Skip to content

Commit f4ba90e

Browse files
authored
Create CONTRIBUTING.md
1 parent 3ea3af9 commit f4ba90e

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Contributing
2+
3+
Thanks for considering a contribution! This is a Move monorepo (Aptos-first, Sui-friendly).
4+
5+
## Dev Setup
6+
- OS: Linux/macOS or Windows + WSL
7+
- Aptos CLI >= 7.8.0
8+
- `./tools/check.sh` runs build + unit tests for all subprojects.
9+
10+
## Conventions
11+
- Use `0x1::...` imports for stdlib (not `std::` in our code/tests).
12+
- Keep test modules `#[test_only]`.
13+
- Each feature/change must include unit tests (positive + at least one negative).
14+
- Commit messages: short, imperative (e.g. `escrow: add refund test; tighten E_NOT_FUNDED`).
15+
16+
## PR Checklist
17+
- [ ] `./tools/check.sh` is green
18+
- [ ] New/changed logic has tests
19+
- [ ] README updated if public API changed
20+
- [ ] No `{{ADDR}}` placeholders
21+
22+
## Project Map
23+
- `mytoken/` — demo token API
24+
- `escrow/` — deal funding/release
25+
- `simplenft/` — minimal NFT registry
26+
- `minimarket/` — list/buy with fee pool
27+
- `paysplit/` — proportional revenue splitter
28+
29+
## Issue Templates
30+
Use **“💼 Hire me”** for paid tasks. For bugs/features, please describe:
31+
- What happened vs expected
32+
- Module/function
33+
- Minimal repro (unit test or steps)

0 commit comments

Comments
 (0)