Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add community guidelines to the documentation or README #1

Closed
sadielbartholomew opened this issue Nov 6, 2020 · 2 comments
Closed
Labels
documentation Improvements or additions to documentation

Comments

@sadielbartholomew
Copy link

Towards my review in openjournals/joss-reviews#2597 I have identified that there is not a clear and accessible description for, quoting the review checklist, " third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support".

Please provide this information in a readily-available location, in practice the documentation and/or README file. A few paragraphs could suffice to cover those three components. Thanks.

@jodemaey jodemaey added the documentation Improvements or additions to documentation label Nov 8, 2020
@jodemaey
Copy link
Member

jodemaey commented Nov 25, 2020

Hi,

Thank you for raising that issue.
This issue was also raised by @eviatarbach in his review and is addressed by the commits:

f87022c
c6a7dee

in the joss branch. These will be merged into the master when the review process is completed and this issue will then be closed.

@sadielbartholomew
Copy link
Author

Thanks @jodemaey, that addresses the issue well so I will close this. I have now ticked the relevant review checklist item.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants