Contributing

home / open-source

There are no strict rules when contributing, but here are my suggestions.

I use a combination of Gitflow Workflow and Forking Workflow.

Steps

  1. Fork the repository.
  2. Create a branch depending on the issue that you are working on. See branch reference list bellow.
  3. Do your work and commit.
  4. Create a Pull Request to the main branch.

Branch reference list

  • feature/{name} - New functionality or refactoring.
  • bugfix/{name} - Fixes existing code.
  • hotfix/{name} - Urgent production fix. Use this if there is a huge bug.
  • support/{name} - Documentation updates & stuff like that.

Replace {name} with the name that best describes what your PR is about.