Skip to content

Latest commit

History

History
27 lines (16 loc) 路 1.61 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) 路 1.61 KB

Contributing

Contributions, issues and feature requests are very welcome. If you are using this app and fixed a bug or improved it, please consider submitting a PR!

You can contact other contributors on Gitter or ping me on Twitter.

If you want to contribute, you must read and accept our Code of Conduct.

Guidelines

General guidelines

  • The master branch is where incoming new features are merged (the next coming release).
  • The production branch is a snapshot of the latest stable release.
  • All hotfix should be done in dedicated branch from the production branch.
  • All new features / bugs should be done in a dedicated branch from the master branch.
  • It's a very nice thing to have multiple small commits as you work on the PR. It's easier to review it. Then we will squash it before merging.

Commit messages

This project uses gitmoji as commit convention, because it's fun and provides an easy way of identifying the purpose or intention of a commit with only looking at the emojis used. All you just have to do is to find the emoji corresponding to the purpose of your commit in this list following by a short message explaining the update. You can also add a description if it's needed. That's all ;)

https://gitmoji.carloscuesta.me/

Adding new features

Ideally you should talk about it on Gitter with other contributors or open a suggestion issue on GitHub.