Skip to content

Commit 065e110

Browse files
ahmetcetinthymikee
authored andcommittedOct 5, 2018
docs: Create CONTRIBUTING.md (#9)
issue #2
1 parent f7f2103 commit 065e110

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed
 

‎CONTRIBUTING.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing
2+
3+
## Code of Conduct
4+
5+
We want this community to be friendly and respectful to each other. Please read [the full text](/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
6+
7+
## Our Development Process
8+
9+
The core team works directly on GitHub and all work is public.
10+
11+
### Development workflow
12+
13+
> **Working on your first pull request?** You can learn how from this *free* series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
14+
15+
1. Fork the repo and create your branch from `master` (a guide on [how to fork a repository](https://help.github.com/articles/fork-a-repo/)).
16+
2. Run `yarn` to setup the developement environment.
17+
3. Do the changes you want and test them out in the example app before sending a pull request.
18+
19+
### Commit message convention
20+
21+
We prefix our commit messages with one of the following to signify the kind of change:
22+
23+
* `fix`: bug fixes, e.g. fix incorrect error message.
24+
* `feat`: new features, e.g. add useful API.
25+
* `refactor`: code/structure refactor, e.g. new folder structure.
26+
* `docs`: changes into documentation, e.g. add usage example for `getByText`.
27+
* `test`: adding or updating tests, eg unit, snapshot testing.
28+
* `chore`: tooling changes, e.g. change circle ci config.
29+
* `BREAKING`: for changes that break existing usage, e.g. change API.
30+
31+
Our pre-commit hooks verify that your commit message matches this format when committing.
32+
33+
### Linting and tests
34+
35+
We use `flow` for type checking, `eslint` with `prettier` for linting and formatting the code, and `jest` for testing. Our pre-commit hooks verify that the linter and tests pass when commiting. You can also run the following commands manually:
36+
37+
* `yarn flow`: run flow on all files.
38+
* `yarn lint`: run eslint and prettier.
39+
* `yarn test`: run tests.
40+
41+
### Sending a pull request
42+
43+
When you're sending a pull request:
44+
45+
* Prefer small pull requests focused on one change.
46+
* Verify that `flow`, `eslint` and tests are passing.
47+
* Preview the documentation to make sure it looks good.
48+
* Follow the pull request template when opening a pull request.
49+
50+
## Reporting issues
51+
52+
You can report issues on our [bug tracker](https://github.com/callstack/react-native-testing-library/issues). Please follow the issue template when opening an issue.
53+
54+
## License
55+
56+
By contributing to `react-native-testing-library`, you agree that your contributions will be licensed under its **MIT** license.

0 commit comments

Comments
 (0)