|
1 | 1 | # Contributing to React Native Async Storage |
2 | 2 |
|
3 | 3 | Thank you for helping out with Async Storage! We'd like to make contributions as |
4 | | -pleasent as possible, so here's a small guide of how we see it. Happy to hear |
| 4 | +pleasant as possible, so here's a small guide of how we see it. Happy to hear |
5 | 5 | your feedback about anything, so please let us know. |
6 | 6 |
|
7 | 7 | ## Tests |
8 | 8 |
|
9 | 9 | We use TypeScript for type check, `eslint` with `prettier` for |
10 | | -linting/formatting, `jest/detox` for tests (unit and e2e). All tests are run on |
11 | | -CircleCI for all opened pull requests, but you should use them locally when |
| 10 | +linting/formatting. All tests are run on Github Actions for all opened pull requests, but you should use them locally when |
12 | 11 | making changes. |
13 | 12 |
|
14 | | -- `yarn test`: Run all tests, except for e2e (see note below). |
15 | 13 | - `yarn test:lint`: Run `eslint` check. |
16 | 14 | - `yarn test:ts`: Run `tsc` type check. |
17 | | -- `yarn test:e2e:<ios|android|macos>`: Runs e2e tests. Before you can run it, |
18 | | - you should build the app that can be run, by using |
19 | | - `yarn build:e2e:<ios|android|macos>`. |
| 15 | +- `yarn test:format`: Run `prettier` check for formatting mistakes. |
20 | 16 |
|
21 | 17 | ## Sending a pull request |
22 | 18 |
|
@@ -65,16 +61,15 @@ Most notably prefixes you'll see: |
65 | 61 |
|
66 | 62 | ## Release process |
67 | 63 |
|
68 | | -We use [Semantic Release](http://semantic-release.org) to automatically release |
69 | | -new versions of the library when changes are merged into `main` branch, which |
70 | | -we plan to keep stable. Bug fixes take priority in the release order. |
| 64 | +We use [Changeset](https://github.com/changesets/changesets) to manage releases. |
| 65 | +In your PR, run `yarn changeset` to create a new changeset, describing your changes. |
| 66 | +The Changeset Bot will help you out during opening a PR. |
71 | 67 |
|
72 | 68 | ## Reporting issues |
73 | 69 |
|
74 | 70 | You can report issues on our |
75 | | -[bug tracker](https://github.com/react-native-community/react-native-async-storage/issues). |
76 | | -Please search for existing issues and follow the issue template when opening an |
77 | | -one. |
| 71 | +[bug tracker](https://github.com/react-native-async-storage/async-storage/issues). |
| 72 | +Please search for existing issues and follow the issue template when opening a one. |
78 | 73 |
|
79 | 74 | ## License |
80 | 75 |
|
|
0 commit comments