Skip to content

Commit 88be71a

Browse files
authored
Merge pull request #315 from mrzachnugent/@zach/update-contributing-md
chore: update contributing.md
2 parents 1020435 + 73e2651 commit 88be71a

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,62 @@ Thank you for your interest in contributing to `react-native-reusables`! We welc
44

55
## How to Contribute
66

7+
> **IMPORTANT**
8+
>
9+
> **If you want to propose a new feature:**
10+
>
11+
> 1. Make sure to read the [project scope](https://github.com/mrzachnugent/react-native-reusables/discussions/229) to confirm your proposal fits within the vision and purpose of `react-native-reusables`.
12+
> 2. Please open a [new discussion](https://github.com/mrzachnugent/react-native-reusables/discussions) before taking any action. This allows us to collaborate, gather feedback, and ensure alignment with the project's goals.
13+
14+
<br />
15+
716
1. Fork the repository to your GitHub account.
817
2. Clone the forked repository to your local machine:
918
```bash
1019
git clone https://github.com/your-username/react-native-reusables.git
1120
cd react-native-reusables
1221
```
13-
1422
3. Create a new branch for your feature or bug fix:
23+
1524
```bash
1625
git checkout -b feature/your-feature-name
1726
```
1827

1928
4. Make your changes and ensure that your code adheres to the existing coding standards.
2029
5. Commit your changes with clear and concise commit messages:
21-
```bash
22-
git commit -m "Add your commit message here"
23-
```
30+
31+
```bash
32+
git commit -m "Add your commit message here"
33+
```
2434

2535
6. Push your changes to your forked repository:
36+
2637
```bash
2738
git push origin feature/your-feature-name
2839
```
2940

3041
7. Open a pull request (PR) against the main branch of the original repository.
3142

3243
## Code Style Guidelines
33-
Please follow the coding style and guidelines used in the project. If there are specific coding conventions, linting rules, or documentation standards, make sure your contributions adhere to them.
44+
45+
Please follow the coding style and guidelines used in the project. If there are specific coding conventions, linting rules, or documentation standards, make sure your contributions adhere to them.
46+
3447
> _If they are not clear, please create an issue and we will create a CODING_STYLE_GUIDELINE.md_
3548
3649
## Issue Tracker
50+
3751
Check the [issue tracker](https://github.com/mrzachnugent/react-native-reusables/issues) for existing issues or open a new issue to discuss and coordinate your contribution with the maintainers.
3852

3953
## Code of Conduct
54+
4055
Please review and adhere to our [Code of Conduct](https://github.com/mrzachnugent/react-native-reusables/blob/main/CODE_OF_CONDUCT.md). Be respectful and considerate towards others.
4156

4257
## License
58+
4359
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](https://github.com/mrzachnugent/react-native-reusables/blob/main/LICENSE) file of this repository.
4460

4561
## Contact
62+
4663
If you have any questions or need further assistance, feel free to contact us at [email protected].
4764

4865
**We appreciate your contributions and look forward to working with you!**

0 commit comments

Comments
 (0)