Skip to content

Commit b426521

Browse files
author
Mateusz Kopciński
committed
review changes
1 parent e3962ff commit b426521

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,14 @@ cd react-native-executorch
5959
git remote add upstream https://github.com/software-mansion/react-native-executorch.git
6060
```
6161

62-
3. Create you develop branch
62+
3. Create your develop branch
6363

6464
```
6565
git checkout -b a-descriptive-name-for-my-changes
6666
```
6767

68-
🚨 Do not work on the main branch!
68+
> [!CAUTION]
69+
> Do not work on the main branch!
6970
7071
4. Follow installation steps in the [README.md](./README.md)
7172

RELEASE.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ The release process of new minor version consists of the following steps:
2323

2424
After the release branch is created and the version is published to npm we only allow for bug fixes and other critical changes to be included into the release branch. For this purpose we use git `cherry-pick` command.
2525

26+
> [!CAUTION]
27+
> Those changes should NOT include documentation changes, as they would be released automatically on the PR's merge and before the code > changes are live. Instead create a separate PR with doc changes according to the [Docs update](#docs-update) section.
28+
2629
1. Create a PR to the main branch.
2730
2. Once the PR is merged, `cherry-pick` the commit to the release branch.
2831
3. Bump version in `package.json` to the new version `v{MAJOR}.{MINOR}.{REVISION}`.
@@ -37,7 +40,8 @@ After the release branch is created and the version is published to npm we only
3740

3841
## Docs update
3942

40-
We are using docusaurus with docs versioning. By default when merging PRs with docs changes to the main branch, a github workflow is started to publish the docs. When updating docs the following steps should be considered.
43+
We are using docusaurus with docs versioning. By default when merging PRs with docs changes to the main branch, a github workflow is started to publish the docs. For this reason those changes should be merged only once the related changes are released.
44+
When updating docs the following steps should be considered.
4145

4246
1. Update the desired doc pages.
4347
2. Check if the changes are applicable to past versions, if so make the same updates to the correct files in versioned docs inside `react-native-executorch/docs/versioned_docs/version-{MAJOR}.{MINOR}.x`.

0 commit comments

Comments
 (0)