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

Community guidelines/contributing etc. #23

Closed
zbeekman opened this issue Jun 3, 2019 · 2 comments
Closed

Community guidelines/contributing etc. #23

zbeekman opened this issue Jun 3, 2019 · 2 comments
Assignees
Milestone

Comments

@zbeekman
Copy link

zbeekman commented Jun 3, 2019

Part of the JOSS review asks about:

Community guidelines: Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support

I'm a bit confused as to how to assess this. I know the eventual plan is, possibly, to integrate this back upstream. But I have yet to pour over upstream's readme document.

I think, at a minimum, you need to include a CONTRIBUTING.md file, with a link from the readme that addresses some of this. You could put all of it in the README, of course, but point 1, "contributing to the software", typically has enough text to warrant its own CONTRIBUTING.md file. For reporting issues or problems, you could add an issue template or templates, and address this in the README. For 3, "seek support", you could delineate which types of issues should be reported upstream through the usual mechanism, whatever that is, and include any details of how to seek support for the CMake/build system portions, even if that is "no support offered, beyond bug reporting and pull requests".

@dmey dmey self-assigned this Jun 10, 2019
@dmey dmey added this to the 4.1.0 milestone Jun 10, 2019
@dmey
Copy link

dmey commented Jun 10, 2019

@zbeekman this should now be fixed in 1264222. Let me know if you would like to see more changes.

@letmaik are you happy with 1264222?

NOTE TO SELF: merge after #24

@letmaik
Copy link

letmaik commented Jun 11, 2019

@dmey Looks good in general, I left some comments about minor things.

dmey added a commit that referenced this issue Jun 11, 2019
Adds community guidelines/contributing etc. as requested in #23.
@dmey dmey closed this as completed Jun 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants