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 inline code examples to contributing guidelines #1924

Merged
merged 4 commits into from
Jun 1, 2022

Conversation

willschlitzer
Copy link
Contributor

This adds to contributing.md to show how to add inline code examples. It also address this comment to document doctest_skip.

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.

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

@willschlitzer willschlitzer added the documentation Improvements or additions to documentation label May 10, 2022
@willschlitzer willschlitzer added this to the 0.7.0 milestone May 10, 2022
@willschlitzer willschlitzer self-assigned this May 10, 2022
doc/contributing.md Outdated Show resolved Hide resolved
doc/contributing.md Outdated Show resolved Hide resolved
doc/contributing.md Outdated Show resolved Hide resolved
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label May 31, 2022
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

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

Thanks for adding this!

@seisman seisman merged commit d04d74a into main Jun 1, 2022
@seisman seisman deleted the contributing-guidelines/doctest-skip branch June 1, 2022 04:27
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jun 1, 2022
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