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

Improve the onboarding access checklist for contributors, maintainers and administrators #2656

Merged
merged 10 commits into from
Sep 4, 2023

Conversation

seisman
Copy link
Member

@seisman seisman commented Sep 3, 2023

Description of proposed changes

Fixes #

Preview: https://pygmt-dev--2656.org.readthedocs.build/en/2656/maintenance.html

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

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

@seisman seisman added this to the 0.11.0 milestone Sep 3, 2023
@seisman seisman added the documentation Improvements or additions to documentation label Sep 3, 2023
@seisman seisman changed the title Improve the onboarding access checklist Improve the onboarding access checklist for contributors, maintainers and administrators Sep 3, 2023
@seisman seisman marked this pull request as ready for review September 3, 2023 06:21
@seisman seisman added the needs review This PR has higher priority and needs review. label Sep 3, 2023
doc/maintenance.md Outdated Show resolved Hide resolved
doc/maintenance.md Outdated Show resolved Hide resolved
doc/maintenance.md Show resolved Hide resolved
doc/maintenance.md Outdated Show resolved Hide resolved
doc/maintenance.md Outdated Show resolved Hide resolved
doc/maintenance.md Show resolved Hide resolved
doc/maintenance.md Outdated Show resolved Hide resolved
Co-authored-by: Yvonne Fröhlich <[email protected]>
doc/maintenance.md Outdated Show resolved Hide resolved
@seisman seisman mentioned this pull request Sep 4, 2023
7 tasks
doc/maintenance.md Show resolved Hide resolved
doc/maintenance.md Show resolved Hide resolved
doc/maintenance.md Show resolved Hide resolved
@michaelgrund michaelgrund added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Sep 4, 2023
doc/maintenance.md Outdated Show resolved Hide resolved
doc/maintenance.md Outdated Show resolved Hide resolved
doc/maintenance.md Outdated Show resolved Hide resolved
Co-authored-by: Yvonne Fröhlich <[email protected]>
doc/maintenance.md Outdated Show resolved Hide resolved
doc/maintenance.md Outdated Show resolved Hide resolved
@seisman seisman merged commit 8aba551 into main Sep 4, 2023
@seisman seisman deleted the access-checklist branch September 4, 2023 20:27
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Sep 4, 2023
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.

4 participants