Skip to content

Latest commit

 

History

History
24 lines (16 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 1.7 KB
Raw

#Contributing to TACA code

When contribution to this package please have the following things in mind:

NOTE: Please make sure that there are no exisiting issues relating to whatever you want to report.

####To contribute:

  1. Create an issue describing the bug / suggestion / improvement / ... here.
  2. Fork this repository to your GitHub account
  3. Make the necessary changes / additions to your forked TACA repository
  4. Please make sure that you've documented your code and changes using sphinx syntax, as the documentation will be automatically generated using this engine, and published to ReadTheDocs
  5. Update the version number in TACA/__init__.py
  6. Pull Request and wait for the responsible reviewer to review and merge the code

Version numbering

When contributing to this repo, also increment the version number in TACA/__init__.py as part of your pull request. If you suspect other pull requests will be merged before yours, simply ask the responsible reviewer to suggest a number after their review. Versioning follows the typical MAJOR.MINOR.REVISION system. Version numbers are set as follows:

  • Revision - Small sized updates such as addressing a logic error or changing what version of a dependency is required
  • Minor - Medium sized updates such as adding a new functionality or optimizing an existing feature
  • Major - Large sized updates that either add a big bundle of functionality, or optimization that required a large section of the repository to be refactored.

That's it! And thanks a lot!