Skip to content

Commit 0144d2d

Browse files
authored
chore: add contributing guide
1 parent e90be85 commit 0144d2d

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing
2+
3+
## Bug fixes
4+
5+
If you've found a bug in Typewind that you'd like to fix, [submit a pull request](https://github.com/mokshit06/typewind/pulls) with your changes. Include a helpful description of the problem and how your changes address it, and provide tests so we can verify the fix works as expected.
6+
7+
## New features
8+
9+
If there's a new feature you'd like to see added to Typewind, [share your idea with us](https://github.com/mokshit06/typewind/discussions/new?category=ideas) in our discussion forum to get it on our radar as something to consider for a future release.
10+
11+
**Please note that we don't often accept pull requests for new features.** Adding a new feature to Typewind requires us to think through the entire problem ourselves to make sure we agree with the proposed API, which means the feature needs to be high on our own priority list for us to be able to give it the attention it needs.
12+
13+
If you open a pull request for a new feature, we're likely to close it not because it's a bad idea, but because we aren't ready to prioritize the feature and don't want the PR to sit open for months or even years.
14+
15+
## Running tests
16+
17+
You can run the test suite using the following commands:
18+
19+
```sh
20+
cargo test
21+
```
22+
23+
To test the features you've added, run the following command:
24+
25+
```sh
26+
npm run build
27+
```
28+
29+
and then run each of the examples in `examples/*` to test that the changes are working as intended.
30+
31+
Please ensure that the tests are passing when submitting a pull request. If you're adding new features to Typewind's SWC plugin, please include tests.

0 commit comments

Comments
 (0)