Skip to content

Commit 7700c12

Browse files
committed
Add CONTRIBUTING guide
1 parent 8cdfab2 commit 7700c12

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

CONTRIBUTING.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Contributing to react-native-edge-to-edge
2+
3+
Thank you for your interest in contributing to **react-native-edge-to-edge**! We appreciate your help in improving this project. Please follow the guidelines below to ensure a smooth contribution process.
4+
5+
## Code of conduct
6+
7+
This project and everyone participating in it is governed by the [Code of conduct](.github/CODE_OF_CONDUCT.md). By participating, you are expected to adhere to this code.
8+
9+
## How can I contribute?
10+
11+
### Reporting bugs
12+
13+
If you encounter any bugs or issues, please report them via [GitHub issues](https://github.com/zoontek/react-native-edge-to-edge/issues). When submitting a bug report, please ensure that you follow the provided template.
14+
15+
### Suggesting features
16+
17+
We are open to discussion! If you have a feature request, please submit it via [GitHub issues](https://github.com/zoontek/react-native-edge-to-edge/issues).
18+
19+
### Contributing code
20+
21+
We welcome pull requests! Here’s how you can contribute:
22+
23+
1. Fork the repository and clone your fork.
24+
2. Create a new branch for your feature or bugfix: `git checkout -b feature/a-name`
25+
3. Write clear and concise code, following the coding guidelines (enforced by [`prettier`](https://prettier.io/)).
26+
4. Test your code using the [example app](./example) on both iOS and Android, and on both React Native architectures.
27+
5. Commit your changes and push to your fork.
28+
6. Open a pull request from your branch to the `main` branch of the main repository.
29+
30+
## Development workflow
31+
32+
### Setting up the project
33+
34+
1. Fork the repository and clone your fork:
35+
36+
```bash
37+
git clone https://github.com/zoontek/react-native-edge-to-edge.git
38+
```
39+
40+
2. Install the dependencies (using [yarn v1](https://github.com/yarnpkg/yarn)):
41+
42+
```bash
43+
cd react-native-edge-to-edge
44+
yarn install
45+
```
46+
47+
3. Install the example app dependencies:
48+
49+
```bash
50+
cd example
51+
yarn install
52+
53+
cd ios
54+
bundle install && bundle exec pod install
55+
```
56+
57+
4. Start the app:
58+
59+
```bash
60+
yarn start
61+
```
62+
63+
### Running checks
64+
65+
We highly encourage running checks (formatting, typing, build, etc.) before committing.
66+
67+
```bash
68+
yarn prepack
69+
```
70+
71+
Thank you for your contributions! 🙌

0 commit comments

Comments
 (0)