Skip to content

Commit 63c6ce7

Browse files
committed
add CONTRIBUTING guide
1 parent 60140c7 commit 63c6ce7

1 file changed

Lines changed: 37 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
Pull requests are welcome!
4+
5+
## Before Opening a PR
6+
7+
Please ensure the following checks pass:
8+
9+
1. Tests are passing:
10+
```bash
11+
bazelisk test //...
12+
```
13+
14+
2. Formatting is correct:
15+
```bash
16+
bazelisk run :fmt
17+
```
18+
19+
3. Lints are passing:
20+
```bash
21+
bazelisk run :lint
22+
```
23+
24+
## Documentation
25+
26+
If new APIs are introduced, they must be documented.
27+
28+
If documentation changes, regenerate the docs in a separate commit:
29+
```bash
30+
bazelisk run //docs:update
31+
```
32+
33+
## PR Guidelines
34+
35+
PR title will be included in the changelog, so make sure it clearly communicates the change.
36+
37+
PR body should communicate the intent of the change - what it does and why.

0 commit comments

Comments
 (0)