geodynamics / best_practices

Software development and training best practices.
13 stars 9 forks source link

Community Guidelines #28

Closed ljhwang closed 5 months ago

ljhwang commented 1 year ago

JOSS ask for (are there) clear guidelines for third parties wishing to 1) contribute to software, 2) report issues or problems with the software, 3) seek support.

We request 2) and 3) when standing up software landing pages and it is also part of the software checklist in support of our best practices. Should we add a minimum best practice (or include in 5. Documentation):

  1. Support. Clearly indicate if the software is actively supported and if so, how to report issues and get help.

In addition, we do not have a statement suggesting that a software package be open to contribute to. This is suggested in the checklist under contributing.md

This overlaps or is the same as #13

ljhwang commented 1 year ago

I have update the minimum best practices to include Support. See PR #29.

However there is no consideration of what, if any, there should be additional requirements for Support under Standard and Target Best Practices.

gassmoeller commented 5 months ago

Closed in #39.