software-development

software-development copied to clipboard

Recommend using 'duecredit' to ensure downstream tools can properly cite all modules?

1

What do folks think of recommending the use of [duecredit](https://github.com/duecredit/duecredit) as a way to ensure citations for all modules can be easily extracted in a standard manner? It is [pip-installable](https://pypi.org/project/duecredit/),...

jchodera

I'm not sure if we currently cover best practices for maintaining a changelog and writing good, useful release notes. If not, we should add a section on this.

jchodera

This already appears in [Structuring Your Project](https://github.com/choderalab/software-development/blob/master/STRUCTURING_YOUR_PROJECT.md#use-the-molssi-cms-cookiecutter)

jchodera

Closes #81

dotsdl

jchodera

We need to overhaul the [Continuous Integration](https://github.com/choderalab/software-development/blob/master/CONTINUOUS_INTEGRATION.md) section to recommend GitHub Actions. Ideally, we should make it as clear as possible how to use GitHub Actions. We can remove all...

jchodera

We may not need to discuss other test frameworks in detail.

jchodera

jchodera

We should add some examples/info on how to create these.

jchodera

Python Coding Conventions: Clarify docstring conventions, especially for array shapes

1

We should further clarify docstring conventions, especially for optional arguments and array shapes. Type hints will also help with this.

jchodera