Skip to content

Commit e35bb47

Browse files
Meghan Jonesweiji14
Meghan Jones
andauthored
Add alias name convention to CONTRIBUTING.md (#1256)
* Add alias name convention to CONTRIBUTING.md * Update CONTRIBUTING.md Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Wei Ji <[email protected]>
1 parent 454c682 commit e35bb47

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

CONTRIBUTING.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ General guidelines for pull requests (PRs):
219219
do.
220220
* Each pull request should consist of a **small** and logical collection of changes.
221221
* Larger changes should be broken down into smaller components and integrated
222-
separately.
222+
separately. For example, break the wrapping of aliases into multiple pull requests.
223223
* Bug fixes should be submitted in separate PRs.
224224
* Use underscores for all Python (*.py) files as per [PEP8](https://www.python.org/dev/peps/pep-0008/),
225225
not hyphens. Directory names should also use underscores instead of hyphens.
@@ -303,6 +303,12 @@ warn us and you can make a new commit with the formatted code.
303303
Even better, you can just write `/format` in the first line of any comment in a
304304
Pull Request to lint the code automatically.
305305

306+
When wrapping a new alias, use an underscore to separate words bridged by vowels
307+
(aeiou), such as `no_skip` and `z_only`. Do not use an underscore to separate
308+
words bridged only by consonants, such as `distcalc`, and `crossprofile`. This
309+
convention is not applied by the code checking tools, but the PyGMT maintainers
310+
will comment on any pull requests as needed.
311+
306312
We also use [flake8](http://flake8.pycqa.org/en/latest/) and
307313
[pylint](https://www.pylint.org/) to check the quality of the code and quickly catch
308314
common errors.

0 commit comments

Comments
 (0)