|
| 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** (use the search bar on GitHub under Issues). 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? This can be a specific model, an entire model family, a code functionality or anything else you think might be useful. 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 | + |
| 29 | +2. Describe it - add as much detail as you can. This helps to avoid any miscommunication problems and helps us to better understand it. |
| 30 | + |
| 31 | +3. Provide a code snippet with the example usage (optional). |
| 32 | + |
| 33 | +4. If there is a similar feature somewhere else drop a link (optional). |
| 34 | + |
| 35 | +## Fix outstanding issues |
| 36 | + |
| 37 | +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. |
| 38 | + |
| 39 | +## Export new models to ET format |
| 40 | + |
| 41 | +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). |
| 42 | + |
| 43 | +## Contributing to examples or documentation |
| 44 | + |
| 45 | +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. |
| 46 | +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, e.g `docs/versioned_docs/version-0.3.x`, `docs/versioned_docs/version-0.4.x`). |
| 47 | + |
| 48 | +# Creating a Pull Request |
| 49 | + |
| 50 | +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. |
| 51 | + |
| 52 | +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. |
| 53 | + |
| 54 | +2. Clone your fork to your local disc, and add the base repository as a remote: |
| 55 | + |
| 56 | +``` |
| 57 | +git clone git@github.com:<your Github handle>/react-native-executorch.git |
| 58 | +cd react-native-executorch |
| 59 | +git remote add upstream https://github.com/software-mansion/react-native-executorch.git |
| 60 | +``` |
| 61 | + |
| 62 | +3. Create your develop branch |
| 63 | + |
| 64 | +``` |
| 65 | +git checkout -b a-descriptive-name-for-my-changes |
| 66 | +``` |
| 67 | + |
| 68 | +> [!CAUTION] |
| 69 | +> Do not work on the main branch! |
| 70 | +
|
| 71 | +4. Follow installation steps in the [README.md](./README.md) |
| 72 | + |
| 73 | +5. Develop your code. |
| 74 | + To keep your fork up to date run |
| 75 | + |
| 76 | +``` |
| 77 | +git fetch upstream |
| 78 | +git rebase upstream/main |
| 79 | +``` |
| 80 | + |
| 81 | +After you are done writing the code push it to the remote |
| 82 | + |
| 83 | +``` |
| 84 | +git push -u origin a-descriptive-name-for-my-changes |
| 85 | +``` |
| 86 | + |
| 87 | +6. Test your changes. |
| 88 | + 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. |
| 89 | + |
| 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