You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: templates/library/CONTRIBUTING.md
+29-6Lines changed: 29 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,39 @@
1
1
# Contributing
2
2
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
-
5
3
We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project.
6
4
7
5
## Development workflow
8
6
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:
10
33
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.
0 commit comments