HowToContribute

How To Contribute To NPLRuntime

Generally, we follow the git flow rules. master branch is locked on github, the dev branch is now the default branch.

To contribute you either fork or clone the repository and check out the dev branch, which is the default branch.

• Create a local feature branch with a sensible name based on latest dev branch
• Make changes to the code and commit to your local feature branch
• When you have passed all the tests, send pull request or merge directly to the dev branch
• Send a pull request to master branch and wait for code review and approval. master branch is considered fairly stable, so it is a locked branch that requires all automatic CI tests to pass and at least one code reviewer approves it.
• Once it is done, you can delete your feature branch both locally and remotely.
• Switch and pull from dev branch again to begin your next feature dev.

for lazy contributors, you can also create your own dev branch and sync with the remote dev branch manually at each issue iteration. But a feature branch just makes life easier when you are working on multiple issues at the same time and you can backup your repo remotely at any time.

Coding Guide Line