You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+30Lines changed: 30 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,6 +63,36 @@ We welcome contributions via:
63
63
- ✅ **Update Documentation:** If your change affects functionality or usage, update relevant documentation.
64
64
- ✅ **Confirm Licensing:** By submitting a PR, you agree to license your contribution under the project's license.
65
65
66
+
## Formatting, linting and testing requirements
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
+
66
96
## Diagrams Style Guide
67
97
68
98
For consistency, follow these styles when creating or updating diagrams:
0 commit comments