Adding CONTRIBUTING document and related infrastructure#8
Merged
Conversation
rmjarvis
reviewed
Jun 6, 2022
rmjarvis
reviewed
Jun 6, 2022
rmjarvis
reviewed
Jun 6, 2022
Member
Author
|
Ok after a bit more research, I've chosen to adopt the code of conduct from the Contributor Covenant I've added myself as point of contact for reporting code of conduct transgressions related to this project. It might be nice to standardize a code of conduct for all of galsim-developers, let me know if you have any thougths on that. |
b-remy
reviewed
Jun 13, 2022
b-remy
requested changes
Jun 13, 2022
Collaborator
b-remy
left a comment
b-remy
left a comment
There was a problem hiding this comment.
I left a small suggestion, otherwise it looks good to me!
Co-authored-by: Benjamin Remy <30293694+b-remy@users.noreply.github.com>
b-remy
approved these changes
Jun 14, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR proposes a set of contributing guidelines which draw in large part from the GalSim guidelines as documented in the GalSim wiki. This could be repurposed for GalSim as well.
One interesting question, is that I didn't find a reference to a Code Of Conduct in the original GalSim, which would be pretty good to have in general for all GalSim-developers projects. As a starting point, I've proposed language to point to the Astropy Code of Conduct, which it not ideal as-is because this code references a confidential contact email to report any problems, which we don't currently have. So I think it would be pretty nice to develop a slightly adjusted version for GalSim-developers. I'll let @rmandelb @rmjarvis comment on that.
In terms of recovering/recapturing practices from the GalSim project, here is where I drew content from:
GalSim Developer Information: Appears to be mostly outdated, but contains explanations about git workflow that I didn't recapture here because it seemed a bit redundant.
GalSim Pull Request Checklist: Here I have copied a number of things, but ignored all references to scons, code style, python 2, and doc update (since in the present case, documentation is inherited from GalSim mostly)
Checklist for new tagged release: most of these things will be different, a lot of it will be automated, so didn't recapture its content for now.