Skip to content

Commit 7647359

Browse files
authored
docs: fix numbered lists and spelling in CONTRIBUTING.md (#2613)
- Update numbered lists to use sequential numbers (2, 3, 4) instead of repeating 1s - Correct spelling from "Chose" to "Choose" in publishing workflow sections
1 parent 9a36a05 commit 7647359

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

CONTRIBUTING.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ All work on React Native CLI happens directly on GitHub. Contributors send pull
77
> **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://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
88
99
1. Fork the repo and create your branch from `main` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
10-
1. Run `yarn` or `npm install` to install all required dependencies.
11-
1. Run `yarn watch` to automatically build the changed files.
12-
1. Now you are ready to do the changes.
10+
2. Run `yarn` or `npm install` to install all required dependencies.
11+
3. Run `yarn watch` to automatically build the changed files.
12+
4. Now you are ready to do the changes.
1313

1414
## Testing your changes
1515

@@ -75,11 +75,11 @@ First make sure you have RN repo checked out and CLI repo checked out and built.
7575

7676
1. Check out `react-native` repo. Then update template in local `react-native/template/package.json`, replacing dependency version of `react-native` with the absolute path of the react native repo, for example: "react-native": "file:///Users/username/react-native" (you can find the absolute path using `pwd` command)
7777

78-
1. Go back up and create a new RN project: `node ./cli/packages/cli/build/bin.js init --template=file:///path/to/local/react-native/RNTestProject`
78+
2. Go back up and create a new RN project: `node ./cli/packages/cli/build/bin.js init --template=file:///path/to/local/react-native/RNTestProject`
7979

80-
1. To work with android, update gradle config in the newly created project following the second part of [Christoph's instructions](https://gist.github.com/cpojer/38a91f90614f35769e88410e3a387b48)
80+
3. To work with android, update gradle config in the newly created project following the second part of [Christoph's instructions](https://gist.github.com/cpojer/38a91f90614f35769e88410e3a387b48)
8181

82-
1. Run start (as described above) and compile your app eg `node ../cli/packages/cli/build/bin.js run-android` (make sure you definitely have NDK r17c installed before building android)
82+
4. Run start (as described above) and compile your app eg `node ../cli/packages/cli/build/bin.js run-android` (make sure you definitely have NDK r17c installed before building android)
8383

8484
## Typechecking, linting and testing
8585

@@ -118,23 +118,23 @@ This part is for maintainers only, documenting steps to manually publish the pac
118118
### Stable version
119119

120120
1. Pull latest changes for the stable branch (we use a _N.x_ convention where _N_ stands for major version of the RNC CLI).
121-
1. Run `yarn run publish`, it will tag the packages as `latest`.
122-
1. Chose an appropriate version from the available options.
123-
1. Create release notes in the project's Release tab.
121+
2. Run `yarn run publish`, it will tag the packages as `latest`.
122+
3. Choose an appropriate version from the available options.
123+
4. Create release notes in the project's Release tab.
124124

125125
### Prerelease
126126

127127
1. Pull latest changes for the `main` branch.
128-
1. Run `yarn run publish:next`, it will tag the packages as `next`.
129-
1. Use `Custom prerelease` option and go with `-alpha.N` convention.
130-
1. Create release notes in the project's Release tab.
128+
2. Run `yarn run publish:next`, it will tag the packages as `next`.
129+
3. Use `Custom prerelease` option and go with `-alpha.N` convention.
130+
4. Create release notes in the project's Release tab.
131131

132132
### Legacy version
133133

134134
1. Pull latest changes for the _N.x_ branch (where N stands for major legacy version).
135-
1. Run `yarn run publish --dist-tag N.x` to tag the packages as `N.x`.
136-
1. Chose an appropriate version from the available options.
137-
1. Create release notes in the project's Release tab.
135+
2. Run `yarn run publish --dist-tag N.x` to tag the packages as `N.x`.
136+
3. Choose an appropriate version from the available options.
137+
4. Create release notes in the project's Release tab.
138138

139139
## Reporting issues
140140

0 commit comments

Comments
 (0)