Protocols

Version Identification

Following PEP440 conventions lets try to go with major.minor.micro where

• major signifies a large development step change
• minor signifies a new feature (or numerous bug fixes)
• minor signifies a bug fix or series of bug fixes I think at this point we won't bother with a(lpha) and b(eta) suffixes.

Style Guide

I'm trying to keep the code as clean as possible, before committing any code changes I run PyLint to flag any dubious syntax or variable naming. Other options would be to use Pycodestyle, but I've opted for PyLint as it's the default within Spyder. An open ticket at the moment is to explore the use of Python/Black to help with the formatting.

Code development

Any development, bug, update should be registered using the issue tracker. Assign the issue to the PyNEMO project (along with an issue type and assignee) and it will automatically appear on the PyNEMO Project web page. When committing any code, link the commit to the issue it address using the suggested protocol. For example: (Closes #123). This will automatically close the ticket and move it to the 'Done' column of the project page. If the commit is working towards closing an issue, please note the issue number in the commit message. Hopefully this will make the process more trackable.