Skip to content

Latest commit

 

History

History
52 lines (29 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

52 lines (29 loc) · 1.83 KB

This file is still Work in Progress

Pull Requests

If you want to contribute to the project please use dev as base branch.

Use master branch ONLY for critical bug fixes.

Once done create the Pull Request to dev branch, if it's a critical bug fix use staging.

Branches

dev

This branch is the main development branch and it's the lowest priority branch under CI.

This branch should always build, sometimes can be necessary break this rule, this is why it's should and not must.

staging

This branch is for testing the product before a new release.

This branch is the one used to make PR to master so this branch MUST build.

master

This branch is the production one.

This must be used for PR only for bug fixes and always MUST build.

Changes to README.md or other markdown files are not priorities so for these changes use dev or staging and they'll be implemented in the next release.

every other branch except gh-pages

You can create any branch you want to push any kind of commits.

There are no rules in the CI for all other branches.

Once ready, if you need to implement in the product follow the rules above.

Backward compatibility

Remember to keep the backward compatibility with previous versions, if a changes breaks this rule must be discussed.

You can mark as obsolete old methods but they must work too. Deprecating is not breaking.


Community

Feel free to join the Slack community to talk about the project. It's easier to share ideas if we can talk directly.

Slack


Happy coding to everyone!