Skip to content

Commit de93392

Browse files
author
Mateusz Kopciński
committed
added REALESE.md and CONTRIBUTING.md files
1 parent dea16ea commit de93392

3 files changed

Lines changed: 119 additions & 0 deletions

File tree

‎.cspell-wordlist.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,4 @@ MPNET
5252
QINT
5353
FNUZ
5454
wordlist
55+
jitpack

‎CONTRIBUTING.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
Thank you for your interest in contributing to react-native-executorch!
2+
3+
# Ways to contribute
4+
5+
There are several ways you can contribute to react-native-executorch
6+
7+
- Submit issues related to bugs or desired new features.
8+
- Fix outstanding issues with the existing code.
9+
- Export new models to ET format
10+
- Contribute to examples or to the documentation
11+
12+
## Submitting a bug-related issue or feature request
13+
14+
Please try to follow those guidelines when creating issues or feature requests. This makes it easier for us to help you with problems or properly consider your suggestions.
15+
For more general questions and discussions please visit our Discord server.
16+
17+
## Found a bug?
18+
19+
Before reporting the issue please check if a similar issue was previously reported, this can be either here or on our Discord server. This will make it much faster for you and us to help you. We prefer you to create issues here on github rather than on Discord as it makes it easier for others to find them later on and makes it easier to include proper context to the problem. When submitting your issue please select a `🐛 Bug` issue template and fill in the required information, this speeds up our responses significantly.
20+
21+
## Feature request
22+
23+
Have an idea or is there a feature you would like to see added? Feel free to create a PR from a fork 😉. Alternatively if you don't have time for that just create a `🚀 Feature request` issue and fill in the necessary information.
24+
The most important things to include are:
25+
26+
1. What is the motivation behind it? Is it something that is missing but is present in another library? Or maybe you need something more specific for your use case? Or just an idea that popped into your head?
27+
We'd love to hear about this!
28+
2. Describe it - add as much detail as you can. This helps to avoid any miscommunication problems and helps us to better understand it.
29+
3. Provide a code snippet with the example usage (optional).
30+
4. If there is a similar feature somewhere else drop a link (optional).
31+
32+
## Fix outstanding issues
33+
34+
If you found an issue you would like to tackle and it is not assigned to anyone at the moment feel free to start working on it. Drop a comment under it so that we know it is under progress and then open a PR. For a good starting issue look for `good first issue` label.
35+
36+
## Export new models to ET format
37+
38+
Found a model you would like to use in your app but it is not currently supplied by us and got it exported and working with ExecuTorch? We would love you to create a PR on our [🤗 huggingface](https://huggingface.co/spaces/software-mansion/README/discussions?status=open&type=pull_request&sort=recently-created).
39+
40+
## Contributing to examples or documentation
41+
42+
Do you have a neat example use case and want to share it with us? You can just drop us a message on Discord server and/or open a PR to `apps` directory here.
43+
If you found some inconsistencies in our documentation or just something is missing just open a PR with suggested changes (remember to add changes to previous docs versions too).
44+
45+
# Creating a Pull Request
46+
47+
Before writing any code reach out to us to make sure no one is currently working on it, you can always open an issue first.
48+
49+
1. Fork the [repository](https://github.com/software-mansion/react-native-executorch) by clicking on the **[Fork](https://github.com/software-mansion/react-native-executorch/fork)** button on the repository's page. This creates a copy of the code under your GitHub use account.
50+
2. Clone your fork to your local disc, and add the base repository as a remote:
51+
52+
```
53+
git clone git@github.com:<your Github handle>/react-native-executorch.git
54+
cd react-native-executorch
55+
git remote add upstream https://github.com/software-mansion/react-native-executorch.git
56+
```
57+
58+
3. Create you develop branch
59+
60+
```
61+
git checkout -b a-descriptive-name-for-my-changes
62+
```
63+
64+
🚨 Do not work on the main branch!
65+
66+
4. Follow installation steps in the [README.md](./README.md)
67+
68+
5. Develop your code.
69+
To keep your fork up to date run
70+
71+
```
72+
git fetch upstream
73+
git rebase upstream/main
74+
```
75+
76+
After you are done writing the code push it to the remote
77+
78+
```
79+
git push -u origin a-descriptive-name-for-my-changes
80+
```
81+
82+
6. Test your changes.
83+
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.
84+
7. Open a pull request
85+
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)

‎RELEASE.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# General Overview
2+
3+
## Minor version release
4+
5+
The release process of new minor version consists of the following steps:
6+
7+
1. When all tickets tracked in a release tracker (i.e. [#356](https://github.com/software-mansion/react-native-executorch/issues/356)) are merged into main branch, release branch named v{MAJOR}.{VERSION} is cut off from the main branch.
8+
2. Stability tests are performed on the release branch and all fixes to the new-found issues are merged into the main branch and cherry-picked into the release branch.
9+
3. Bump the version inside `package.json` in the root and commit to the release branch with commit message 'release: Bump version to v{MAJOR}.{MINOR}.0`.
10+
4. Tag release branch with proper version tag (v{MAJOR}.{VERSION}.0) and run `npm publish`.
11+
5. Create versioned docs by running from repo root `(cd docs && yarn docusaurus docs:version {MAJOR}.{MINOR}.x)`.
12+
6. Create a PR with updated docs.
13+
7. Ensure [jitpack](https://jitpack.io/#software-mansion/react-native-executorch) triggers build properly.
14+
8. Create release notes on github.
15+
16+
## Patch release
17+
18+
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.
19+
20+
1. Create a PR to the main branch.
21+
2. Once the PR is merged, `cherry-pick` the commit to the release branch.
22+
3. Bump the version inside `package.json` in the root and commit to the release branch with commit message 'release: Bump version to v{MAJOR}.{MINOR}.{PATCH}`.
23+
4. Tag release branch with proper version tag (v{MAJOR}.{VERSION}.{PATCH}) and run `npm publish`.
24+
5. Ensure [jitpack](https://jitpack.io/#software-mansion/react-native-executorch) triggers build properly.
25+
6. Create release notes on github.
26+
27+
## Docs update
28+
29+
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.
30+
31+
1. Update the desired doc pages.
32+
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`.
33+
3. Create a PR to the main branch.

0 commit comments

Comments
 (0)