Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

51 lines (33 loc) · 1.92 KB
Raw

Contributing

First off, thank you for considering contributing to Gatsby Mate Starter. With the help of all the contributors this starter is always up to date and free of bugs, resulting in a better application for everybody 😄

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

Where do I go from here?

If you've noticed a bug or have a feature request, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one!

Fork & create a branch

If this is something you think you can fix, then fork Gatsby Starter Mate and create a branch with a descriptive name.

The name of the branch must start with the type of the pull request, followed with a short description of what it's trying to achieve.

feat  - A new feature.
fix   - A bug fix.
docs  - Documentation only changes

Example: feat/new-top-bar or fix/broken-project-link

Setting Up the Code for Local Development

  1. Fork the gatsby-mate-starter repo on GitHub.
  2. Create a branch for local development::
  $ git checkout -b name-of-your-bugfix-or-feature
  1. Install dependencies
  $ yarn
  1. Commit your changes and push your branch to GitHub::
  $ git add .
  $ git commit -m "Your detailed description of your changes."
  $ git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

After the pull request is submitted TravisCI is going to run all the automated tasks that ensure a minimium code quality. This is a mandatory requirement in order to merge your pul request.