Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Asserting CONTRIBUTING guidelines. #489

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing

Thank you for helping this project become a better library :)

- [Triage](#triage)
- [Reporting Bugs](#reporting-bugs)
- [Providing a feature request](#providing-a-feature-request)
- [Pull requests](#pull-requests)

## Triage

This is one of the easiest and most effective ways of helping out. If you see an open issue, try and reproduce the bug yourself, and comment with the result. If the issue is lacking any information to reproduce the bug, let the author know.

## Reporting Bugs

Open an issue, making sure to follow the bug report template.

## Providing a feature request

Open an issue, making sure to follow the Feature request template.

## Pull requests

### Getting started

- If there isn't one already, open an issue describing the bug or feature request that you are going to solve in your pull request.
- Create a fork of react-native-maps
- If you already have a fork, make sure it is up to date
- Git clone your fork and run `yarn` in the base of the cloned repo to setup your local development environment.
- Create a branch from the master branch to start working on your changes.

### Committing

- When you made your changes, run `yarn lint` & `yarn test` to make sure the code you introduced doesn't cause any obvious issues.
- When you are ready to commit your changes, use the [Github conventional commits](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13) convention for you commit messages, as we use your commits when releasing new versions.
- Use present tense: "add awesome component" not "added awesome component"
- Limit the first line of the commit message to 100 characters
- Reference issues and pull requests before committing

### Creating the pull request

- The title of the PR needs to follow the same conventions as your commit messages, as it might be used in case of a squash merge.
- Create the pull request against the beta branch.