Skip to content

Commit 670ed10

Browse files
committed
fix: update docs with more info
1 parent 47fdd6b commit 670ed10

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

packages/create-react-native-library/templates/common/CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ To get started with the project, run `yarn` in the root directory to install the
1010
yarn
1111
```
1212

13-
While developing, you can run the [example app](/example/) to test your changes.
13+
> While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development.
14+
15+
While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app.
1416

1517
To start the packager:
1618

@@ -80,6 +82,16 @@ We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint]
8082

8183
Our pre-commit hooks verify that the linter and tests pass when committing.
8284

85+
### Publishing to npm
86+
87+
We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc.
88+
89+
To publish new versions, run the following:
90+
91+
```sh
92+
yarn release
93+
```
94+
8395
### Scripts
8496

8597
The `package.json` file contains various scripts for common tasks:

0 commit comments

Comments
 (0)