Skip to content

Latest commit

 

History

History
69 lines (41 loc) · 1.9 KB

CONTRIBUTION.md

File metadata and controls

69 lines (41 loc) · 1.9 KB
Raw

Contributing to LeapDAO

You are more than welcome to contribute to LeapDAO! Follow these guidelines and you will be ready to start:

Code of conduct

Please read and follow our Code of conduct.

Git Guidelines

Generally, development should be done directly towards the master branch.

Workflow

  1. Fork and clone the repository

    git clone [email protected]:YOUR-USERNAME/LEAPDAO_REPONAME.git

  2. Create a branch in the fork

    The branch should be based on the master branch in the master repository. Prepend the correct type to your branch.

    git checkout -b TYPE/my-feature-or-bugfix master

  3. Commit changes on your branch

    Commit changes to your branch, following the commit message format.

    git commit -m "properly formatted SET statements."

  4. Push the changes to your fork

    git push -u myfork TYPE/my-feature-or-bugfix

  5. Create a Pull Request

    In the Github UI of your fork, create a Pull Request to the master branch of the master repository.

    If the branch has merge conflicts or has been outdated, please do a rebase against the master branch.

Commit message guidelines

Commit messages should follow the commit message convention.

Type

Should be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • chore: Changes to build and dev processes/tools
  • docs: Changes to documentation
  • style: Changes to code style formatting (white space, commas etc)

Scope

The <scope> of the commit is optional and can be omitted. When used though, it should describe the place or part of the project, e.g. docs(examples), feat(data) etc.