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
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,6 @@
2
2
3
3
Thanks for your interest in contributing to Cap!
4
4
5
-
## Ways to help
6
-
7
-
- Report bugs by opening issues.
8
-
- Suggest features with clear use cases.
9
-
- Improve docs or add examples.
10
-
- Submit pull requests.
11
-
12
5
## Development setup
13
6
14
7
**Notes**:
@@ -21,18 +14,21 @@ Thanks for your interest in contributing to Cap!
21
14
22
15
Run `bun install` in each Bun package you want to work on to install dependencies.
23
16
24
-
## Guidelines
17
+
## Tips
25
18
26
19
- Formatting uses [Biome](https://biomejs.dev/). Make sure there are no warnings or errors before submitting a PR.
27
20
28
-
- Keep PRs small and focused.
29
-
30
21
- We prefer conventional commits, but they are not enforced. See [here](https://www.conventionalcommits.org/en/v1.0.0/) for reference.
31
22
32
23
- No AI-generated code please. AI autocomplete is fine, but not fully AI code. If you submit AI-generated code without making it clear, it may be rejected.
33
24
34
25
- Type files are auto-generated from JSDoc comments
35
26
36
-
- For optimizations, please always publish a benchmark of the before/after difference before submitting a PR, ideally including your device specs. RAM/CPU usage is also appreciated.
37
27
38
-
Maintainers may reject PRs at their discretion if they don't follow these guidelines or don't align with the project's goals.
28
+
## Code of Conduct
29
+
30
+
* Be respectful to others. Please keep unstructured critique to a minimum. If you have solid ideas you want to experiment with, make a fork and see how it works.
31
+
32
+
* Any spamming, trolling, flaming, or baiting is not welcome.
33
+
34
+
* Keep contributions constructive and in good faith.
0 commit comments