Skip to content

Commit 9b8f37b

Browse files
committed
Create CONTRIBUTING.md
1 parent 5cfc414 commit 9b8f37b

File tree

1 file changed

+97
-0
lines changed

1 file changed

+97
-0
lines changed

CONTRIBUTING.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# Contributing Guide to `@reason-react-native/__template__`
2+
3+
We love your input! We want to make contributing to this project as easy and
4+
transparent as possible, whether it's:
5+
6+
- Reporting a bug
7+
- Discussing the current state of the code
8+
- Submitting a fix
9+
- Proposing new features
10+
- Becoming a maintainer
11+
12+
We use GitHub to
13+
14+
- host code
15+
- track issues and feature requests
16+
- accept pull requests.
17+
- tag & publish release as well as pushing those to npm.
18+
19+
## Reporting bugs or requesting a feature
20+
21+
We use GitHub issues to track public bugs or discuss about new features. Please
22+
write bug reports or feature requests with detail, background, and sample code
23+
if necessary.
24+
25+
Just try to
26+
[open a new issue](https://github.com/reason-react-native/__template__/issues/new/choose)
27+
& follow the instructions that should be prefilled for
28+
[bug](.github/ISSUE_TEMPLATE/bug.md) or
29+
[feature request](.github/ISSUE_TEMPLATE/feature.md).
30+
31+
People _love_ thorough bug reports. Not even kidding.
32+
33+
## Fixing bugs & implementing features
34+
35+
We use [Github flow](https://guides.github.com/introduction/flow/index.html), so
36+
most code changes happen through Pull Requests.
37+
38+
[Pull Requests](https://help.github.com/en/articles/about-pull-requests) are the
39+
best way to propose changes to the codebase since they notify watchers & allow
40+
contributors to discuss about changes.
41+
42+
We actively welcome your pull requests.
43+
44+
To make a pull request, you need to:
45+
46+
1. [Fork the repo](https://help.github.com/en/articles/fork-a-repo)
47+
2. Clone it and install dependencies
48+
49+
```console
50+
git clone https://github.com/reason-react-native/__template__
51+
cd __template__
52+
yarn
53+
```
54+
55+
3. Create a local branch, from `master` (unless specified differently)
56+
57+
```console
58+
git checkout -b <name-of-your-branch>
59+
```
60+
61+
4. Add your changes!
62+
63+
- If you've added code that should be tested, add tests.
64+
- If you've changed APIs, update the documentation.
65+
66+
5. Ensure the everything is still fine.
67+
68+
```console
69+
yarn test
70+
```
71+
72+
6. Commit & push your branch online
73+
74+
```console
75+
git add -A .
76+
git commit -m "Your commit message"
77+
```
78+
79+
7. [Create a pull request](https://help.github.com/en/articles/creating-a-pull-request)
80+
81+
_If you are new to Git or GitHub, we encourage you to have a look to
82+
[makeapullrequest.com](http://makeapullrequest.com)._
83+
84+
## Code styling
85+
86+
Everything as been automated: as soon as you commit, everything should be
87+
automatically reformated if necessary (thanks to a transparent git hook) so we
88+
don't have to think about it!
89+
90+
## Licensing
91+
92+
By contributing, you agree that your contributions will be licensed under our
93+
MIT License.
94+
95+
When you submit code changes, your submissions are understood to be under the
96+
same [MIT License](./LICENSE) that covers the project. Feel free to contact the
97+
maintainers if that's a concern.

0 commit comments

Comments
 (0)