Skip to content

Latest commit

 

History

History
94 lines (64 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

94 lines (64 loc) · 2.57 KB
Raw

Contributing Guide to @rescript-react-native

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We use GitHub to

  • host code
  • track issues and feature requests
  • accept pull requests.
  • tag & publish release as well as pushing those to npm.

Reporting bugs or requesting a feature

We use GitHub issues to track public bugs or discuss about new features. Please write bug reports or feature requests with detail, background, and sample code if necessary.

Just try to open a new issue & follow the instructions that should be prefilled for bug or feature request.

People love thorough bug reports. Not even kidding.

Fixing bugs & implementing features

We use Github flow, so most code changes happen through Pull Requests.

Pull Requests are the best way to propose changes to the codebase since they notify watchers & allow contributors to discuss about changes.

We actively welcome your pull requests.

To make a pull request, you need to:

  1. Fork the repo
  2. Clone it
  3. Install dependencies using npm
npm install
  1. Create a local branch, from master (unless specified differently)
git checkout -b <name-of-your-branch>
  1. Add your changes!
  • If you've added code that should be tested, add tests.
  • If you've changed APIs, update the documentation.
  1. Ensure the everything is still fine.
npm run test
  1. Commit & push your branch online
git add -A .
git commit -m "Your commit message"
  1. Create a pull request

If you are new to Git or GitHub, we encourage you to have a look to makeapullrequest.com.

Code styling

Everything as been automated: as soon as you commit, everything should be automatically reformated if necessary (thanks to a transparent git hook) so we don't have to think about it!

Licensing

By contributing, you agree that your contributions will be licensed under our MIT License.

When you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.