gmso
gmso copied to clipboard
Possible starting points for new contributors
I wanted to point to a few ideas that would involve useful, but relatively small, changes to the codebase that would be good for new users to
-
Add unit tests to increase code coverage. Our score is pretty good (GMSO 0.2.0 is at 95.06%) but there are still plenty of lines of the source code not covered by unit tests. Here would be the starting point, click through different parts of the code for lines highlighted in red and see if you can trigger them in a new unit test.
-
Add or update docstrings. Anytime you
from gmso.core.foo import Foo
, dohelp(Foo)
to see the docstring. These are mostly complete but can be improved. If anything looks off, or if any useful information is neglected, please update the docstrings. -
Add doc examples. The "examples" part of any doc page are constructed from inside the Python code. See this, which comes from here, and note the "Examples" section.
-
Add a
PotentialTemplate
for some potential not yet supported. See this file for a starting point -
Convert existing file I/O from whatever in-house code or personal scripts you may be using into readers and writers that take or return GMSO objects. This entire module includes some examples; for a simple case consider looking at the
xyz.py
-
Add XML files to testing or reference data, preferrably either simple ones that are easy to write or exotic ones that would require added functionality. See #211
Please add any other good starting points @mosdef-hub/mosdef-maintainers and consider chipping away at these tasks @mosdef-hub/mosdef-contributors