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

Add guidelines for managing issues to maintenance.md #1301

Merged
merged 6 commits into from
May 28, 2021
Merged

Conversation

maxrjones
Copy link
Member

Description of proposed changes

This PR adds a few guidelines for managing issues to the PyGMT maintenance guide. Mostly, it details the assignment feature for issues discussed in #1113 (I will submit a separate PR related to PRs) and also clarifies how to handle upstream issues (which I found confusing at first).

Fixes #

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@maxrjones maxrjones marked this pull request as draft May 26, 2021 19:14
@maxrjones maxrjones self-assigned this May 26, 2021
doc/maintenance.md Outdated Show resolved Hide resolved
doc/maintenance.md Outdated Show resolved Hide resolved
@seisman seisman added this to the 0.4.0 milestone May 26, 2021
@seisman seisman added the documentation Improvements or additions to documentation label May 26, 2021
Copy link
Member

@seisman seisman 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 to me except for a minor edit.

doc/maintenance.md Outdated Show resolved Hide resolved
Co-authored-by: Dongdong Tian <[email protected]>
doc/maintenance.md Outdated Show resolved Hide resolved
@weiji14 weiji14 added the final review call This PR requires final review and approval from a second reviewer label May 28, 2021
@maxrjones maxrjones marked this pull request as ready for review May 28, 2021 15:42
@maxrjones maxrjones merged commit 4d9e935 into master May 28, 2021
@maxrjones maxrjones deleted the issues-guide branch May 28, 2021 16:45
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label May 28, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants