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

Adopt Contributor Covenant Code of Conduct version 2.1 #1324

Merged
merged 14 commits into from
Jun 28, 2022

Conversation

namurphy
Copy link
Member

@namurphy namurphy commented Oct 30, 2021

This PR is to update our code of conduct to the Contributor Covenant Code of Conduct v2.1.

Our current code of conduct is a hybrid between Astropy's and an older version of the Contributor Covenant. One of the things missing from our current code of conduct is an enforcement policy (#403). Versions 2.0 and 2.1 of the Contributor Covenant do an enforcement policy, which is a significant improvement on our current code of conduct. The Contributor Covenant is also effectively becoming the standard code of conduct for open source projects, and it was even the code of conduct that we adopted for Plasma Hack Week. The Contributor Covenant is also time-tested and community-maintained. This PR would need the approval of the Coordinating Committee, I think.

Remaining tasks...

  • Create the contact email address for the code of conduct
  • Check that the documentation builds correctly
  • Add a badge to README.md (following instructions on the Contributor Covenant website)
  • Add a changelog entry

Closes #403. Closes #853. This follows up on #854.

@namurphy namurphy added docs PlasmaPy Docs at http://docs.plasmapy.org status: needs discussion Issues & PRs that need to be discussed at a community meeting or by the Coordinating Committee labels Oct 30, 2021
@codecov
Copy link

codecov bot commented Oct 30, 2021

Codecov Report

Merging #1324 (f35c361) into main (6c67fdc) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1324   +/-   ##
=======================================
  Coverage   97.21%   97.21%           
=======================================
  Files          83       83           
  Lines        7961     7961           
=======================================
  Hits         7739     7739           
  Misses        222      222           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6c67fdc...f35c361. Read the comment docs.

Copy link
Member

@StanczakDominik StanczakDominik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That did not diff well at all. 😅

Looks good to me, though!

good faith may face temporary or permanent repercussions as determined
by other members of the project’s leadership.
be reported to the community leaders responsible for enforcement at
``[email protected]``. All complaints will be reviewed and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does sphinx have an email role?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another possible solution...

https://github.com/sphinx-contrib/email

changelog/1324.doc.rst Outdated Show resolved Hide resolved
good faith may face temporary or permanent repercussions as determined
by other members of the project’s leadership.
be reported to the community leaders responsible for enforcement at
[email protected]. All complaints will be reviewed and
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It turns out that Sphinx will render email addresses correctly with a mailto: prefix if they show up in plain text.

@namurphy
Copy link
Member Author

namurphy commented Dec 3, 2021

Earlier this afternoon I incorporated @rocco8773's suggestions and made a few other slight changes, so this is ready for review again. I also created the conduct at plasmapy.org email group. Thanks!

StanczakDominik
StanczakDominik previously approved these changes Dec 4, 2021
@namurphy namurphy enabled auto-merge (squash) June 28, 2022 18:57
@namurphy namurphy merged commit 5aee981 into PlasmaPy:main Jun 28, 2022
@namurphy namurphy deleted the contributor-covenant-2.1 branch June 28, 2022 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org status: needs discussion Issues & PRs that need to be discussed at a community meeting or by the Coordinating Committee
Projects
None yet
3 participants