ximinhu/mass-suite

mass-suite's Issues

Unit tests are not working or missing

I couldn’t find the unit tests or testing framework or they are failing and not working for me. If you don’t have any, then make sure you justify this decision somewhere, maybe the README.md. I’m skeptical that any bit of code doesn’t need unit tests.

README.md needs more documentation

The README.md is the first thing everyone will see when they hit your repository. Make sure it has a good overview of the code and how to get started information. It isn’t necessary to put all that in the README.md itself, but you can point to that documentation elsewhere from within the README.md.

Also, there are a couple / few spelling mistakes in the README.

Check the .gitignore

I see things like __pycache__ and ipynb checkpoint files.