Improve code readability and maintainability - Githubissues

MobleyLab / blues

Applications of nonequilibrium candidate Monte Carlo (NCMC) to ligand binding mode sampling

https://mobleylab-blues.readthedocs.io/en/latest

MIT License

33 stars 16 forks source link

Improve code readability and maintainability #147

Closed nathanmlim closed 6 years ago

nathanmlim commented 6 years ago

To improve code readability and maintainability, I'll be incorporating some best practices from MolSSI which include:

[x] Add a standardized python .gitignore file
[x] Format code to adhere to Google's YAPF format
[x] Add Sphinx docs to the repository
[x] Format docstrings to adhere to the numpydoc style
[x] Refactor unittests to follow pytest
[x] Add codecov report
[x] Add an issue template in the .github/
[x] Add versioneer to repository
[x] Continuous integration for py3.5/3.6 and Mac/linux

nathanmlim commented 6 years ago

Closing, these (plus other features were added in PR #154