Skip to content

Commit 465da2a

Browse files
authored
Update CONTRIBUTING.md
1 parent a030b9d commit 465da2a

File tree

1 file changed

+22
-31
lines changed

1 file changed

+22
-31
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,70 @@
11
# Contributing
22

3-
Thank you for considering contributing to this package! Let's get you started.
3+
**Thank you for considering contributing to this package**! This small guide will help you get started.
44

5-
## 1. Fork & Clone
5+
## 🍽️ Fork + Clone
66

7-
- Make a fork of this repository
8-
- Navigate to your forked repository and copy the SSH url. Clone your fork locally:
7+
1. Make a fork of this repository
8+
2. Navigate to your forked repository and copy the SSH url. Clone your fork locally:
99

1010
```bash
1111
$ git clone [email protected]:{ YOUR_USERNAME }/rtk-query-loader.git
1212
$ cd rtk-query-loader
1313
```
1414

15-
- Once cloned, you will see `origin` as your default remote, pointing to your personal forked repository. Add a remote named upstream pointing to the main rtk-query-loader:
15+
3. Once cloned, you will see `origin` as your default remote, pointing to your personal forked repository. Add a remote named upstream pointing to the main rtk-query-loader:
1616

1717
```bash
1818
$ git remote add upstream [email protected]:ryfylke-react-as/rtk-query-loader.git
1919
$ git remote -v
2020
```
2121

22-
## 2. Create a new branch
22+
## Create a new branch
2323

24-
- First, make sure you have the latest changes:
24+
1. First, make sure you have the latest changes:
2525

2626
```bash
2727
$ git pull upstream main
2828
```
2929

30-
- Then create a new feature branch for your changes:
30+
2. Create a new feature branch for your changes:
3131

3232
```bash
3333
$ git checkout -b { YOUR_BRANCH_NAME } main
3434
```
3535
36-
## 3. Add changes
36+
## 👩‍💻 Add your changes
3737
3838
For now, try to following existing patterns. Formalized code-guidelines will come at some point.
3939
40-
## 4. Test you changes
40+
If you have any questions, feel free to open up an issue!
4141
42-
- First, make sure you create a link between your local package and the testing-app. In the root of the repository:
42+
## 🩺 Test you changes
4343
44-
```bash
45-
$ yarn run setup-link
46-
```
47-
48-
> If this doesn't work, try to run the commands manually:
49-
>
50-
> ```bash
51-
> $ npm link
52-
> $ cd testing-app
53-
> $ npm link @ryfylke-react/rtk-query-loader
54-
> ```
55-
56-
- In the `testing-app` directory, install dependencies, and then run the tests:
44+
1. In the `testing-app` directory, install the project dependencies, and then run the tests:
5745
5846
```bash
5947
$ yarn install
6048
$ yarn run test
6149
```
6250
63-
- If you are adding a new feature, make sure to write a new test for your change in `testing-app/tests.test.tsx`.
51+
2. If you are adding a new feature, make sure to write a new test for your change in `testing-app/tests.test.tsx` and rerun.
6452
65-
## 5. Commit & Push
66-
67-
- Commit your changes and push
53+
## 🤜 Push your changes
54+
If all the tests pass, you can commit your final changes and push!
6855
6956
```bash
7057
$ git commit -a -m "feat: withLoader now has a new argument, ..."
7158
$ git push origin { YOUR_BRANCH_NAME }
7259
```
7360
74-
- We prefer it if you try to stick to [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/#summary).
61+
> We prefer it if you try to stick to [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/#summary).
7562
76-
## 6. Create pull-request
63+
## 📄 Create a pull-request
7764
78-
- In Github, navigate to [@ryfylke-react/rtk-query-loader](https://github.com/ryfylke-react-as/rtk-query-loader) and click the button that reads "Compare & pull request".
65+
- On Github, navigate to [@ryfylke-react/rtk-query-loader](https://github.com/ryfylke-react-as/rtk-query-loader) and click the button that reads "Compare & pull request".
7966
- Write a title and description, and submit your pull request.
67+
68+
Your code will be reviewed and if everything looks good you'll be added to the list of contributors.
69+
70+
Any contribution is appreciated 🤘

0 commit comments

Comments
 (0)