Skip to content

Commit 8a02b25

Browse files
committed
docs: add contributing guidelines to the project
1 parent a218467 commit 8a02b25

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing to swr-catalyst
2+
3+
First off, thank you for considering contributing! It's people like you that make open source such a great community.
4+
5+
## Getting Started
6+
7+
1. **Fork the repository** and clone it to your local machine.
8+
2. **Install dependencies:**
9+
```bash
10+
npm install
11+
```
12+
3. **Run the tests** to make sure everything is set up correctly:
13+
```bash
14+
npm test
15+
```
16+
17+
## Making Changes
18+
19+
1. Create a new branch for your feature or bug fix.
20+
2. Make your changes. Please make sure to add or update tests as appropriate.
21+
3. Ensure all tests pass before submitting your change.
22+
23+
## Submitting a Pull Request
24+
25+
1. Push your changes to your fork.
26+
2. Open a pull request to the `main` branch of the original repository.
27+
3. Provide a clear description of the problem and solution in your pull request. Include the relevant issue number if applicable.
28+
29+
Thank you for your contribution!

0 commit comments

Comments
 (0)