Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

37 lines (26 loc) · 1.3 KB

Contributing

I would be more than happy to have you contribute to this project!

How To Contribute

  • check the existing issues to see if one matches the change you would like to add
  • fork this project
  • create a descriptive branch name that starts with your name
  • make all changes on this newly created branch
  • push this branch to your fork
  • submit a pull request

Best Practices

Make sure to follow these conventions:

  • Commit message must begin with a type prefix. i.e. feat, fix, etc.
  • Commit message must have a solid subject line that describes the work that was done.

Example of a commit message:

feat: adding in a loading spinner component, displayed during API calls, and component loading.
Commit Message Types:
  • feat: a new feature
  • fix: a bug fix
  • docs: changes to documentation
  • style: formatting, missing semi colons, etc; no code change
  • refactor: refactoring production code
  • test: adding tests, refactoring test; no production code change
  • chore: updating build tasks, package manager configs, etc; no production code change

Commit message types taken from Udacity's git-style guide. View the style guide at: http://udacity.github.io/git-styleguide/