Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 1.42 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.42 KB

Contributing

  1. Refer to the development doc to familiarize yourself with the codebase.
  2. When contributing to this repository please first create a new issue before starting your work.
  3. Fork this repository and create your topic branch from development (see Branches section below).
  4. Edit the code in your fork and add test cases for the same.
  5. If you have added new provardx command then update the documentation (README.md) with the signature of new method.
  6. Ensure the test suite passes.
  7. Make sure your code lints.
  8. Issue the pull request when you are done. We'll review your code, suggest any needed (if required), and merge it.

Branches

  • We work in development.
  • Release (aka. production) branch is master.
  • Our work happens in topic branches (feature and/or bug-fix).
    • feature as well as bug-fix branches are based on development

Merging between branches

  • topic branches are:
    • based on development and will be squash-merged into development.

Merging development into master

  • When a development cycle finishes, the content of the development branch will be merged in master branch.
$ git checkout master
$ git merge development
$ git push -u origin master

Pull Requests

  • Develop features and bug fixes in topic branches.
  • Create a pull request for merging topic branch in development.