Skip to content

Commit b7c7009

Browse files
committed
fix: improve contributing docs
1 parent b2c22d0 commit b7c7009

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

templates/library/CONTRIBUTING.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,39 @@
11
# Contributing
22

3-
When contributing to this repository, please first discuss the change you wish to make by opening an issue in this repository before making a change.
4-
53
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.
64

75
## Development workflow
86

9-
> **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
7+
To get started with the project, run `yarn bootstrap` in the root directory to install the required dependencies for each package:
8+
9+
```sh
10+
yarn bootstrap
11+
```
12+
13+
While developing, you can run the [example app](/example/) with [Expo](https://expo.io/) to test your changes:
14+
15+
```sh
16+
yarn example start
17+
```
18+
19+
Make sure your code passes TypeScript and ESLint. Run the following to verify:
20+
21+
```sh
22+
yarn typescript
23+
yarn lint
24+
```
25+
26+
To fix formatting errors, run the following:
27+
28+
```sh
29+
yarn lint --fix
30+
```
31+
32+
Remember to add tests for your change if possible. Run the unit tests by:
1033

11-
1. Fork the repo and create your branch from `master` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
12-
2. Run `yarn bootstrap` to setup the development environment.
13-
3. Do the changes you want and test them out in the example app before sending a pull request.
34+
```sh
35+
yarn test
36+
```
1437

1538
### Commit message convention
1639

0 commit comments

Comments
 (0)