contributing_git

When working on a community environment, its of the most importance to keep everything organized, so here are the main parts of the thing:

Pull requests

When opening a pull request we want to be able to easily see what it does and where it does. So the title must contain:

[optional status][module name][action] - [title]

• optional status: this tag is optional, it describes one of: WIP, TEST (PR with statuses won't be merged until solved)
• module name: being one of the modules of this package, such as server, router, config, model
• action: refactor, feature, fix, doc
• title: a small title to explain what this PR is suggesting

Examples

[WIP][Router][Feature] - Added option to macro routes
[Server][Refactor] - Simplified internal code

In the PR description, you should separate it with a: description, what it adds, what it edits, what it deletes.

Issues

When creating an issue, follow the same instruction as a pull request in your issue title. You are required to follow our templates when submiting, we are going to close issues that do not explain properly what it proposes or the author won't reply when requested to.

Branches

Branches should not be created, you should fork your repository and work through pull requests.