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

Structure contributing guide to support more details #5878

Merged
merged 2 commits into from
Oct 19, 2021
Merged

Conversation

maxrjones
Copy link
Member

Description of proposed changes

There are several open issues that will require adding sections to the contributing guide (e.g., #364, #3313, #3314, #5724). This PR migrates the majority of the contributing guide to the devdocs section of the ReST documentation, keeping only a simple CONTRIBUTING.md in the base of the repository with links to the various sections (following GenericMappingTools/pygmt#1205), which will make the contributing guide easier to navigate as the content expands.

Fixes #

Reminders

  • Make sure that your code follows our style. Use the other functions/files as a basis.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Describe changes to function behavior and arguments in a comment below the function declaration.
  • If adding new functionality, add a detailed description to the documentation and/or an example.

@maxrjones maxrjones added the documentation Improve documentation label Oct 19, 2021
@maxrjones maxrjones requested a review from PaulWessel October 19, 2021 21:07
Copy link
Member

@PaulWessel PaulWessel left a comment

Choose a reason for hiding this comment

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

Looks good!

@maxrjones maxrjones merged commit 21922b2 into master Oct 19, 2021
@maxrjones maxrjones deleted the contrib-guide branch October 19, 2021 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants