CTU-Bern / presize

Precision Based Sample Size Calculation
https://ctu-bern.github.io/presize/
GNU General Public License v3.0
15 stars 13 forks source link

Improve community guidelines #67

Closed TomKellyGenetics closed 3 years ago

TomKellyGenetics commented 3 years ago

Review: Community guidelines

Part of review for JOSS.

Contributing guidelines

Regarding this criteria, the Contributing guidleines are available (as requested in https://github.com/CTU-Bern/presize/issues/61).

1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

However, efforts should be made to direct users to these and guide new users through this process (I note some have been made already).

Some of these are not strictly necessary for publication but are minor efforts that aid novice R users for bug reporting or seeking support via GitHub. See the community GitHub page for further recommendations.

aghaynes commented 3 years ago

Thanks @TomKellyGenetics.

I've added issue templates (already in the main fork) and a PR template (in PR #64) and added a link on the readme to the contributing md file (also in PR #64).

Thanks also for pointing out the community page... I'd not noticed that...

aghaynes commented 3 years ago

@TomKellyGenetics, I've merged #61. Documentation typically takes about 10 mins to compile.

TomKellyGenetics commented 3 years ago

Thanks, I wasn't aware of the GitHub Discussions feature, it seems useful for engaging with the user community! Some of what you have there to discuss with the developers might be better suited to Projects though.

aghaynes commented 3 years ago

Thanks @TomKellyGenetics.

We've only just started thinking about them, so they're there more so that we dont forget about them... i might well move some to projects when we actually start on them...