Skip to content

Commit 54e0da3

Browse files
committed
docs: contribution
1 parent 3c49ba1 commit 54e0da3

File tree

3 files changed

+10
-13
lines changed

3 files changed

+10
-13
lines changed

.github/CONTRIBUTING.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,18 @@
11
# Contributing to React Native Async Storage
22

33
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
55
your feedback about anything, so please let us know.
66

77
## Tests
88

99
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
1211
making changes.
1312

14-
- `yarn test`: Run all tests, except for e2e (see note below).
1513
- `yarn test:lint`: Run `eslint` check.
1614
- `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.
2016

2117
## Sending a pull request
2218

@@ -65,16 +61,15 @@ Most notably prefixes you'll see:
6561

6662
## Release process
6763

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.
7167

7268
## Reporting issues
7369

7470
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.
7873

7974
## License
8075

.github/scripts/prepare-mkdocs.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@
88

99

1010
cp packages/async-storage/CHANGELOG.md docs/changelog.md
11+
cp .github/CONTRIBUTING.md docs/contributing.md

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ nav:
1010
- 'Error handling': api/errors.md
1111
- 'Brownfield integration': api/brownfield.md
1212
- 'Migration to v3': migration-to-3.md
13+
- Contributing: contributing.md
1314
- Changelog: changelog.md
1415

1516

0 commit comments

Comments
 (0)