diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 951f264..2297ea2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,13 +2,6 @@ Thanks for your interest in contributing to Cap! -## Ways to help - -- Report bugs by opening issues. -- Suggest features with clear use cases. -- Improve docs or add examples. -- Submit pull requests. - ## Development setup **Notes**: @@ -21,18 +14,21 @@ Thanks for your interest in contributing to Cap! Run `bun install` in each Bun package you want to work on to install dependencies. -## Guidelines +## Tips - Formatting uses [Biome](https://biomejs.dev/). Make sure there are no warnings or errors before submitting a PR. -- Keep PRs small and focused. - - We prefer conventional commits, but they are not enforced. See [here](https://www.conventionalcommits.org/en/v1.0.0/) for reference. - 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. - Type files are auto-generated from JSDoc comments -- 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. -Maintainers may reject PRs at their discretion if they don't follow these guidelines or don't align with the project's goals. \ No newline at end of file +## Code of Conduct + +* 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. + +* Any spamming, trolling, flaming, or baiting is not welcome. + +* Keep contributions constructive and in good faith. \ No newline at end of file