Skip to content

Commit 09313ba

Browse files
authored
chore: Fix formatting and punctuation in CONTRIBUTING.md (#1195)
## Description When checking if contributing instructions are up to date, I spotted some formatting issues. ### Introduces a breaking change? - [ ] Yes - [x] No ### Type of change - [ ] Bug fix (change which fixes an issue) - [ ] New feature (change which adds functionality) - [x] Documentation update (improves or adds clarity to existing documentation) - [ ] Other (chores, tests, code style improvements etc.) ### Tested on - [ ] iOS - [ ] Android ### Testing instructions <!-- Provide step-by-step instructions on how to test your changes. Include setup details if necessary. --> ### Screenshots <!-- Add screenshots here, if applicable --> ### Related issues <!-- Link related issues here using #issue-number --> ### Checklist - [ ] I have performed a self-review of my code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have updated the documentation accordingly - [ ] My changes generate no new warnings ### Additional notes <!-- Include any additional information, assumptions, or context that reviewers might need to understand this PR. -->
1 parent 71a4e18 commit 09313ba

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@ Thank you for your interest in contributing to react-native-executorch!
22

33
# Ways to contribute
44

5-
There are several ways you can contribute to react-native-executorch
5+
There are several ways you can contribute to react-native-executorch:
66

77
- Submit issues related to bugs or desired new features.
88
- Fix outstanding issues with the existing code.
9-
- Export new models to ET format
10-
- Contribute to examples or to the documentation
9+
- Export new models to ET format.
10+
- Contribute to examples or to the documentation.
1111

1212
## Submitting a bug-related issue or feature request
1313

@@ -59,7 +59,7 @@ cd react-native-executorch
5959
git remote add upstream https://github.com/software-mansion/react-native-executorch.git
6060
```
6161

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

6464
```
6565
git checkout -b a-descriptive-name-for-my-changes
@@ -68,17 +68,17 @@ git checkout -b a-descriptive-name-for-my-changes
6868
> [!CAUTION]
6969
> Do not work on the main branch!
7070
71-
4. Follow installation steps in the [README.md](./README.md)
71+
4. Follow installation steps in the [README.md](./README.md).
7272

7373
5. Develop your code.
74-
To keep your fork up to date run
74+
To keep your fork up to date run:
7575

7676
```
7777
git fetch upstream
7878
git rebase upstream/main
7979
```
8080

81-
After you are done writing the code push it to the remote
81+
After you are done writing the code push it to the remote:
8282

8383
```
8484
git push -u origin a-descriptive-name-for-my-changes
@@ -87,5 +87,5 @@ git push -u origin a-descriptive-name-for-my-changes
8787
6. Test your changes.
8888
Make sure to test on both Android and IOS. Devices are best, but naturally testing on simulator would be just fine. You can use example apps in the `apps` directory for your testing purposes.
8989

90-
7. Open a pull request
91-
For details on how to open a pull request from a fork please visit [github's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
90+
7. Open a pull request.
91+
For details on how to open a pull request from a fork please visit [github's documentation](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).

0 commit comments

Comments
 (0)