Skip to content

Conversation

@maxrjones
Copy link
Member

Description of proposed changes

This PR adds a convention for when to separate words in aliases by an underscore to CONTRIBUTING.md. Originally suggested by @weiji14 in #1190 (comment).

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

Copy link
Member

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

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

Just one comment, otherwise looks good!

Co-authored-by: Wei Ji <[email protected]>
@seisman seisman added this to the 0.4.0 milestone May 4, 2021
@seisman seisman added the documentation Improvements or additions to documentation label May 4, 2021
Copy link
Contributor

@willschlitzer willschlitzer left a comment

Choose a reason for hiding this comment

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

Looks good!

"Is 'aeiou' the term to describe when words are bridged by vowels?" -Me, just now 🤦‍♂️

@maxrjones maxrjones merged commit e35bb47 into master May 4, 2021
@maxrjones maxrjones deleted the contributing-aliases branch May 4, 2021 22:19
@maxrjones
Copy link
Member Author

Sorry for forgetting to shorten the commit message when merging...

sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
* Add alias name convention to CONTRIBUTING.md

* Update CONTRIBUTING.md

Co-authored-by: Wei Ji <[email protected]>

Co-authored-by: Wei Ji <[email protected]>
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.

6 participants