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 underscore guideline to CONTRIBUTING.md #1034

Merged
merged 5 commits into from
Mar 12, 2021
Merged

Conversation

willschlitzer
Copy link
Contributor

@willschlitzer willschlitzer commented Mar 10, 2021

As mentioned by @core-man in #1024, this adds to the convention of underscores between words in file names in the contributing guidelines.

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

@willschlitzer willschlitzer added the documentation Improvements or additions to documentation label Mar 10, 2021
@willschlitzer willschlitzer added this to the 0.3.1 milestone Mar 10, 2021
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@willschlitzer willschlitzer changed the title Add hyphen guideline to CONTRIBUTING.md Add underscore guideline to CONTRIBUTING.md Mar 11, 2021
CONTRIBUTING.md Outdated Show resolved Hide resolved
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman
Copy link
Member

seisman commented Mar 11, 2021

I think we should apply the underscore rule to directories. For example, a URL like the one below is pretty weird.

https://www.pygmt.org/dev/gallery/3d-plots/3d_perspective_view.html

@willschlitzer
Copy link
Contributor Author

I think we should apply the underscore rule to directories. For example, a URL like the one below is pretty weird.

https://www.pygmt.org/dev/gallery/3d-plots/3d_perspective_view.html

Added in e9102b3

@seisman seisman merged commit 2e96ac9 into master Mar 12, 2021
@seisman seisman deleted the hyphen-guidelines branch March 12, 2021 20:11
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
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.

4 participants