Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

47 lines (27 loc) · 1.41 KB
Raw

Contributing

Branching model

We use git-flow as our branching model.

So, paella have two main branches:

  • master is the stable version. And only is updated in each new release version.

  • develop is the develop branch, all new features will be commited to this branch.

When we want to release a new stable version of paella, we create a new branch (release/<version>)

  • release/<version> is a release candidate branch. In this branch we only anccept bug fixes. No new features will be accepted in this branch. All new features will be commited to develop branch.

Contributing

If you want to create a new feature, you need to branch of develop. When your feature is finished, you can make a pull-request to the develop branch.

If you are fixing a bug in a release version, you need to branch of release/<version>. Once the bug is fixed, you can make a pull-request to the release<version> branch.

Making a new feature

You have to create a new branch from develop

$git checkout develop
$git checkout -b feature/my-new-feature

When your new feature is finished, edit the CHANGELOG file and add a line explaining your new feature. Then make a pull-request to de develop branch.

Syntax

Before making a pull request, ensure that syntax style is correct. You can check this by running the line:

grunt checksyntax