Skip to content

Added: Table of Contents - #1001

Merged
weiji14 merged 1 commit into
GenericMappingTools:masterfrom
aliciaha1997:patch-1
Mar 4, 2021
Merged

Added: Table of Contents#1001
weiji14 merged 1 commit into
GenericMappingTools:masterfrom
aliciaha1997:patch-1

Conversation

@aliciaha1997

Copy link
Copy Markdown
Contributor

Added a table of contents in relation to issue #993

Description of proposed changes

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

Added a table of contents in relation to issue GenericMappingTools#993
@welcome

welcome Bot commented Mar 4, 2021

Copy link
Copy Markdown

💖 Thanks for opening this pull request! 💖

Please make sure you read our contributing guidelines and abide by our code of conduct.

A few things to keep in mind:

  • If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
  • All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
  • No matter what, we are really grateful that you put in the effort to do this! 🎉

@willschlitzer willschlitzer added this to the 0.3.1 milestone Mar 4, 2021
@willschlitzer willschlitzer linked an issue Mar 4, 2021 that may be closed by this pull request

@willschlitzer willschlitzer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nice work!

@weiji14
weiji14 merged commit ce5cd2f into GenericMappingTools:master Mar 4, 2021
@welcome

welcome Bot commented Mar 4, 2021

Copy link
Copy Markdown

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

Please open a new pull request to add yourself to the AUTHORS.md file. We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

@weiji14

weiji14 commented Mar 4, 2021

Copy link
Copy Markdown
Member

Cảm ơn 😄

@core-man

core-man commented Mar 4, 2021

Copy link
Copy Markdown
Member

🎉🎉🎉

@seisman seisman added documentation Improvements or additions to documentation maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog and removed documentation Improvements or additions to documentation labels Mar 4, 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

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.

Add "Table of Contents" to MAINTENANCE.md

5 participants