Skip to content

Commit add8605

Browse files
committed
Merge pull request gcanti#95 from gcanti/contributing
add contributing guidelines
2 parents e1cfffe + 258fc7f commit add8605

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Contributing Guide
2+
3+
Contributions are welcome and are greatly appreciated! Every little bit helps, and credit will
4+
always be given.
5+
6+
## Issues Request Guidelines
7+
8+
Before you submit an issue, check that it meets these guidelines:
9+
10+
- specify the version of `tcomb-form-native` you are using
11+
- specify the version of `react-native` you are using
12+
- if the issue regards a bug, please provide a minimal failing example / test
13+
14+
## Pull Request Guidelines
15+
16+
Before you submit a pull request from your forked repo, check that it meets these guidelines:
17+
18+
1. If the pull request fixes a bug, it should include tests that fail without the changes, and pass
19+
with them.
20+
2. If the pull request adds functionality, the docs should be updated as part of the same PR.
21+
3. Please rebase and resolve all conflicts before submitting.
22+
23+
## Setting up your environment
24+
25+
After forking tcomb-form-native to your own github org, do the following steps to get started:
26+
27+
```sh
28+
# clone your fork to your local machine
29+
git clone https://github.com/gcanti/tcomb-form-native.git
30+
31+
# step into local repo
32+
cd tcomb-form-native
33+
34+
# install dependencies
35+
npm install
36+
```
37+
38+
### Running Tests
39+
40+
```sh
41+
npm test
42+
```
43+
44+
### Style & Linting
45+
46+
This codebase adheres to a custom style and is
47+
enforced using [ESLint](http://eslint.org/).
48+
49+
It is recommended that you install an eslint plugin for your editor of choice when working on this
50+
codebase, however you can always check to see if the source code is compliant by running:
51+
52+
```sh
53+
npm run lint
54+
```
55+

0 commit comments

Comments
 (0)