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

Update the instructions for checking README syntax #2265

Merged
merged 2 commits into from
Dec 22, 2022

Conversation

maxrjones
Copy link
Member

Description of proposed changes

Refer to the TestPyPI previews rather than running setup.py in the release instructions for checking the README syntax.

Fixes #2173

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

@yvonnefroehlich yvonnefroehlich mentioned this pull request Dec 22, 2022
65 tasks
@seisman seisman added this to the 0.8.0 milestone Dec 22, 2022
@seisman seisman added maintenance Boring but important stuff for the core devs final review call This PR requires final review and approval from a second reviewer labels Dec 22, 2022
@seisman seisman merged commit fc8ecda into main Dec 22, 2022
@seisman seisman deleted the release-readme-checking branch December 22, 2022 11:26
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update instructions for checking README syntax for release
4 participants