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: CONTRIBUTING.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ The core team works directly on GitHub and all work is public.
10
10
11
11
### Development workflow
12
12
13
-
> **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/courses/how-to-contribute-to-an-open-source-project-on-github).
13
+
> **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/courses/how-to-contribute-to-an-open-source-project-on-github).
14
14
15
15
1. Fork the repo and create your branch from `main` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
16
16
2. Run `yarn bootstrap` on the root level, to setup the development environment.
@@ -20,45 +20,45 @@ The core team works directly on GitHub and all work is public.
20
20
21
21
We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
22
22
23
-
*`fix`: bug fixes, e.g. fix Button color on DarkTheme.
24
-
*`feat`: new features, e.g. add Snackbar component.
25
-
*`refactor`: code refactor, e.g. new folder structure for components.
26
-
*`docs`: changes into documentation, e.g. add usage example for Button.
27
-
*`test`: adding or updating tests, eg unit, snapshot testing.
28
-
*`chore`: tooling changes, e.g. change circleci config.
29
-
*`BREAKING CHANGE`: for changes that break existing usage, e.g. change API of a component.
23
+
-`fix`: bug fixes, e.g. fix Button color on DarkTheme.
24
+
-`feat`: new features, e.g. add Snackbar component.
25
+
-`refactor`: code refactor, e.g. new folder structure for components.
26
+
-`docs`: changes into documentation, e.g. add usage example for Button.
27
+
-`test`: adding or updating tests, eg unit, snapshot testing.
28
+
-`chore`: tooling changes, e.g. change circleci config.
29
+
-`BREAKING CHANGE`: for changes that break existing usage, e.g. change API of a component.
30
30
31
31
Our pre-commit hooks verify that your commit message matches this format when committing.
32
32
33
33
### Linting and tests
34
34
35
35
We use `typescript` for type checking, `eslint` with `prettier` for linting and formatting the code, and `jest` for testing. Our pre-commit hooks verify that the linter and tests pass when commiting. You can also run the following commands manually:
36
36
37
-
*`yarn typescript`: type-check files with `tsc`.
38
-
*`yarn lint`: lint files with `eslint` and `prettier`.
39
-
*`yarn test`: run unit tests with `jest`.
37
+
-`yarn typescript`: type-check files with `tsc`.
38
+
-`yarn lint`: lint files with `eslint` and `prettier`.
39
+
-`yarn test`: run unit tests with `jest`.
40
40
41
41
### Sending a pull request
42
42
43
43
When you're sending a pull request:
44
44
45
-
* Prefer small pull requests focused on one change.
46
-
* Verify that `typescript`, `eslint` and all tests are passing.
47
-
* Preview the documentation to make sure it looks good.
48
-
* Follow the pull request template when opening a pull request.
45
+
- Prefer small pull requests focused on one change.
46
+
- Verify that `typescript`, `eslint` and all tests are passing.
47
+
- Preview the documentation to make sure it looks good.
48
+
- Follow the pull request template when opening a pull request.
49
49
50
50
When you're working on a component:
51
51
52
-
* Follow the guidelines described in the [official material design docs](https://material.io/guidelines/).
53
-
* Write a brief description of every prop when defining `type Props` to aid with documentation.
54
-
* Provide an example usage for the component (check other components to get a idea).
55
-
* Update the type definitions for Flow and TypeScript if you changed an API or added a component.
52
+
- Follow the guidelines described in the [official material design docs](https://material.io/guidelines/).
53
+
- Write a brief description of every prop when defining `type Props` to aid with documentation.
54
+
- Provide an example usage for the component (check other components to get a idea).
55
+
- Update the type definitions for Flow and TypeScript if you changed an API or added a component.
56
56
57
57
### Running the example
58
58
59
59
The example app uses [Expo](https://expo.dev/) for the React Native example. You will need to install the Expo app for [Android](https://play.google.com/store/apps/details?id=host.exp.exponent) and [iOS](https://itunes.apple.com/app/apple-store/id982107779) to start developing.
60
60
61
-
After you're done, you can run `yarn example start` in the project root (or `expo start` in the `example/` folder) and scan the QR code to launch it on your device.
61
+
After you're done, you can run `yarn example start` in the project root (or `npx expo start` in the `example/` folder) and scan the QR code to launch it on your device.
62
62
63
63
To run the example on web, run `yarn example web` in the project root.
0 commit comments