Skip to content

README: Reorganize the Contributing section - #4793

Merged
seisman merged 3 commits into
mainfrom
readme/coc
Aug 3, 2026
Merged

README: Reorganize the Contributing section#4793
seisman merged 3 commits into
mainfrom
readme/coc

Conversation

@seisman

@seismanseisman commented Aug 3, 2026

Copy link
Copy Markdown
Member

Our "Imposter syndrome disclaimer" was adapted from the MetPy project. After reviewing the MetPy README (https://github.com/Unidata/MetPy#code-of-conduct), I feel that their structure is more appropriate.

  1. Previously, "Code of Conduct" was a subsection under "Contributing". However, the Code of Conduct applies not only to contributing but also to other project-related activities, such as asking questions on forums. Therefore, this PR promotes "Code of Conduct" from a level-3 heading to a level-2 heading.

  2. Currently, we have two separate subsections: "Contributing Guidelines" and "Imposter syndrome disclaimer". Following the MetPy style, this PR combines these two subsections into a single section.

Our "Imposter syndrome disclaimer" is now different from the MetPy one, I wonder if we should just update ours to match the MetPy one. If yes, then it should be done in a separate PR.

Preview: https://github.com/GenericMappingTools/pygmt/tree/readme/coc

@seismanseisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels Aug 3, 2026
@seismanseisman added this to the 0.20.0 milestone Aug 3, 2026

@yvonnefroehlichyvonnefroehlich left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good!

@seisman
seisman merged commit 6921dd3 into mainAug 3, 2026
9 of 10 checks passed
@seisman
seisman deleted the readme/coc branch August 3, 2026 08:25
@seismanseisman removed the needs review This PR has higher priority and needs review. label Aug 3, 2026
@yvonnefroehlichyvonnefroehlich changed the title DOC/README: Reorganize the Contributing sectionREADME: Reorganize the Contributing sectionAug 6, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationskip-changelogSkip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@seisman@yvonnefroehlich