Skip to content

Commit d97f6cc

Browse files
committed
fix(contributing): improve contributing guidelines
1 parent ed064ac commit d97f6cc

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,36 @@ We welcome contributions via:
6363
- ✅ **Update Documentation:** If your change affects functionality or usage, update relevant documentation.
6464
- ✅ **Confirm Licensing:** By submitting a PR, you agree to license your contribution under the project's license.
6565
66+
## Formatting an linting guidelines
67+
68+
1. Build the project and verify internal links:
69+
70+
```bash
71+
npm run build
72+
```
73+
74+
2. Run formatting, linting, and type‑checking:
75+
76+
```bash
77+
npm run format && npm run lint && npm run typecheck
78+
```
79+
80+
3. Validate external links using [lychee](https://github.com/lycheeverse/lychee):
81+
82+
```bash
83+
lychee --config lychee.toml .
84+
```
85+
86+
4. (Optional) If you’ve added or modified scripts under any `examples/developer-hub-*/` directory, navigate into that example’s folder and run its formatter and test suite.
87+
See the example’s `README.md` for more instructions, e.g.:
88+
89+
```bash
90+
cd examples/developer-hub-rust/
91+
cargo build
92+
cargo fmt && cargo clippy --fix
93+
cargo test
94+
```
95+
6696
## Diagrams Style Guide
6797
6898
For consistency, follow these styles when creating or updating diagrams:

0 commit comments

Comments
 (0)