search

IMMM-SFA / tell

A model to predict Total ELectricity Loads (TELL)
https://immm-sfa.github.io/tell/
BSD 2-Clause "Simplified" License
26 stars 10 forks source link

[JOSS] Contact/Help and Contribution Guidelines #38

Closed euronion closed 2 years ago

euronion commented 2 years ago

Contact/Help

Does the option for users to contact you or a mailinglist / tag in popular social media exists, which users with questions can use? Or should users with questions open Issues on GitHub?

Whatever preferred option you have should be included in the documentation.

Contribution Guidelines For good contributions and bug reports I suggest you specify which information users should include when they open Issues for Bug Reports or Features Requests (similar to what you have specified for Pull Requests in the Contribution Guidelines). Alternatively or in addition you can use GitHub templates for Issues and PRs (example).

euronion commented 2 years ago

xref https://github.com/openjournals/joss-reviews/issues/4472

mcgrathc commented 2 years ago

Contact help has been added to the README documentation: https://github.com/IMMM-SFA/tell/blob/main/README.md. Contribution Guidelines have been added for bug/feature reports in this PR for contributing.rst: https://github.com/IMMM-SFA/tell/pull/41. GitHub templates for Issues and PRs were also added.