Skip to content

Commit 16cfb85

Browse files
authored
docs: update contributing guidelines (#517)
1 parent dcdd5ca commit 16cfb85

2 files changed

Lines changed: 10 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,6 @@ cd -
4848
yarn ios
4949
```
5050

51-
The example is configured to build with the new architecture (Fabric) by default.
52-
53-
To confirm that the app is running with the new architecture, you can check the Metro logs for a message like this:
54-
55-
```sh
56-
Running "ReactNativeBottomTabsExample" with {"fabric":true,"initialProps":{"concurrentRoot":true},"rootTag":1}
57-
```
58-
59-
Note the `"fabric":true` and `"concurrentRoot":true` properties.
60-
6151
Make sure your code passes TypeScript and ESLint. Run the following to verify:
6252

6353
```sh
@@ -98,16 +88,22 @@ We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint]
9888

9989
Our pre-commit hooks verify that the linter and tests pass when committing.
10090

101-
### Publishing to npm
91+
### Changesets
10292

10393
We use [changesets](https://github.com/changesets/changesets) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
10494

105-
To publish new versions, run the following:
95+
If your changes impact packages that need to be published, you need to create a changeset for those changes. You can do that by running the following command:
10696

10797
```sh
108-
yarn publish-packages
98+
yarn changeset
10999
```
110100

101+
Changes to example apps or docs don't require a changeset.
102+
103+
### Publishing to npm
104+
105+
After merging a PR to `main`, if it included a changeset, the CI workflow will automatically create another `chore: version packages` PR bumping the version of the impacted packages. Merging this PR will trigger the release workflow, which will automatically publish the new versions to npm.
106+
111107
### Sending a pull request
112108

113109
> **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://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ https://github.com/user-attachments/assets/09e96ac3-827d-4ac0-add0-e7b88ee9197c
3636
| Name | Latest Version |
3737
| ---------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------: |
3838
| [react-native-bottom-tabs](/packages/react-native-bottom-tabs) | [![badge](https://img.shields.io/npm/v/react-native-bottom-tabs?style=for-the-badge)](https://www.npmjs.com/package/react-native-bottom-tabs) |
39+
| [@bottom-tabs/expo-template](/packages/expo-template) | [![badge](https://img.shields.io/npm/v/@bottom-tabs/expo-template.svg?style=for-the-badge)](https://www.npmjs.com/package/@bottom-tabs/expo-template) |
3940
| [@bottom-tabs/react-navigation](/packages/react-navigation) | [![badge](https://img.shields.io/npm/v/@bottom-tabs/react-navigation.svg?style=for-the-badge)](https://www.npmjs.com/package/@bottom-tabs/react-navigation) |
4041

4142
## Documentation

0 commit comments

Comments
 (0)