Skip to content

Move MAINTENANCE.md to documentation#1185

Merged
seisman merged 1 commit intomasterfrom
doc-maintenance
Apr 6, 2021
Merged

Move MAINTENANCE.md to documentation#1185
seisman merged 1 commit intomasterfrom
doc-maintenance

Conversation

@seisman
Copy link
Member

@seisman seisman commented Apr 6, 2021

Description of proposed changes

  • Move MAINTENANCE.md to the doc directory and rename it to "maintenance.md"
  • Add "maintenance.md" to "doc/index.rst"
  • Remove MANIFEST.in from MANIFEST.in
  • Remove TOC in "maintenance.md"
  • A few styling fixes
  • Fix "changes.rst" to "changes.md"

Fixes #1181.

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

@seisman seisman marked this pull request as ready for review April 6, 2021 02:54
@seisman seisman added this to the 0.4.0 milestone Apr 6, 2021
@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Apr 6, 2021
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 skip-changelog Skip adding Pull Request to changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move MAINTENANCE.md to the documentation?

2 participants