Skip to content

Commit c5bb7ae

Browse files
Fix typos in Contributors Guide and Maintainers Guide (#2175)
1 parent 1134a40 commit c5bb7ae

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

doc/contributing.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and we encourage all to read it carefully.
1414

1515
### Ways to Contribute Documentation and/or Code
1616

17-
* Tackle any issue that you wish! Some issues are labeled as **"good first issues"** to
17+
* Tackle any issue that you wish! Some issues are labeled as **"good first issue"** to
1818
indicate that they are beginner friendly, meaning that they don't require extensive
1919
knowledge of the project.
2020
* Make a tutorial or gallery example of how to do something.
@@ -44,7 +44,7 @@ and we encourage all to read it carefully.
4444
### Reporting a Bug
4545

4646
* Find the [*Issues*](https://github.com/GenericMappingTools/pygmt/issues) tab on the
47-
top of the GitHub repository and click *New Issue*.
47+
top of the GitHub repository and click *New issue*.
4848
* Click on *Get started* next to *Bug report*.
4949
* **Please try to fill out the template with as much detail as you can**.
5050
* After submitting your bug report, try to answer any follow up questions about the bug
@@ -56,7 +56,7 @@ If you are aware that a bug is caused by an upstream GMT issue rather than a
5656
PyGMT-specific issue, you can optionally take the following steps to help resolve
5757
the problem:
5858

59-
* Add the line `pygmt.config(GMT_VERBOSE='d')` after your import statements, which
59+
* Add the line `pygmt.config(GMT_VERBOSE="d")` after your import statements, which
6060
will report the equivalent GMT commands as one of the debug messages.
6161
* Either append all messages from running your script to your GitHub issue, or
6262
filter the messages to include only the GMT-equivalent commands using a command
@@ -74,7 +74,7 @@ the problem:
7474
### Submitting a Feature Request
7575

7676
* Find the [*Issues*](https://github.com/GenericMappingTools/pygmt/issues) tab on the
77-
top of the GitHub repository and click *New Issue*.
77+
top of the GitHub repository and click *New issue*.
7878
* Click on *Get started* next to *Feature request*.
7979
* **Please try to fill out the template with as much detail as you can**.
8080
* After submitting your feature request, try to answer any follow up questions as best

doc/maintenance.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ instead.
2424
branch are in the `dev` folder. Pages for each release are in their own folders.
2525
**Automatically updated by GitHub Actions** so you shouldn't have to make commits here.
2626

27-
## Managing GitHub issues
27+
## Managing GitHub Issues
2828

2929
A few guidelines for managing GitHub issues:
3030

@@ -40,7 +40,7 @@ A few guidelines for managing GitHub issues:
4040
possible, post a comment when an upstream PR is merged that fixes the problem, and
4141
consider adding a regression test for serious bugs.
4242

43-
## Reviewing and merging pull requests
43+
## Reviewing and Merging Pull Requests
4444

4545
A few guidelines for reviewing:
4646

@@ -73,15 +73,15 @@ There are 11 configuration files located in `.github/workflows`:
7373

7474
1. `style_checks.yaml` (Code lint and style checks)
7575

76-
This is run on every commit to the *main* and Pull Request branches.
76+
This is run on every commit to the *main* and pull request branches.
7777
It is also scheduled to run daily on the *main* branch.
7878

7979
2. `ci_tests.yaml` (Tests on Linux/macOS/Windows)
8080

81-
This is run on every commit to the *main* and Pull Request branches.
81+
This is run on every commit to the *main* and pull request branches.
8282
It is also scheduled to run regular tests daily and run full tests
8383
(including doctests) on Wednesday on the *main* branch.
84-
In draft Pull Requests, only two jobs on Linux are triggered to save on
84+
In draft pull requests, only two jobs on Linux are triggered to save on
8585
Continuous Integration resources:
8686

8787
- Minimum [NEP29](https://numpy.org/neps/nep-0029-deprecation_policy)
@@ -95,8 +95,8 @@ There are 11 configuration files located in `.github/workflows`:
9595

9696
3. `ci_docs.yml` (Build documentation on Linux/macOS/Windows)
9797

98-
This is run on every commit to the *main* and Pull Request branches.
99-
In draft Pull Requests, only the job on Linux is triggered to save on
98+
This is run on every commit to the *main* and pull request branches.
99+
In draft pull requests, only the job on Linux is triggered to save on
100100
Continuous Integration resources.
101101

102102
On the *main* branch, the workflow also handles the documentation
@@ -172,7 +172,7 @@ supported version of Python. Minimum Python and NumPy version support should be
172172
adjusted upward on every major and minor release, but never on a patch release.
173173

174174

175-
## Backwards compatibility and deprecation policy
175+
## Backwards Compatibility and Deprecation Policy
176176

177177
PyGMT is still undergoing rapid development. All of the API is subject to change
178178
until the v1.0.0 release. Versioning in PyGMT is based on the
@@ -221,11 +221,11 @@ The version number is set automatically using setuptools_scm based information
221221
obtained from git.
222222
There are a few steps that still must be done manually, though.
223223

224-
### Updating the changelog
224+
### Updating the Changelog
225225

226226
The Release Drafter GitHub Action will automatically keep a draft changelog at
227227
https://github.com/GenericMappingTools/pygmt/releases, adding a new entry
228-
every time a Pull Request (with a proper label) is merged into the main branch.
228+
every time a pull request (with a proper label) is merged into the main branch.
229229
This release drafter tool has two configuration files, one for the GitHub Action
230230
at .github/workflows/release-drafter.yml, and one for the changelog template
231231
at .github/release-drafter.yml. Configuration settings can be found at
@@ -245,7 +245,7 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html
245245
```
246246
[![Digital Object Identifier for PyGMT vX.Y.Z](https://zenodo.org/badge/DOI/10.5281/zenodo.<INSERT-DOI-HERE>.svg)](https://doi.org/10.5281/zenodo.<INSERT-DOI-HERE>)
247247
```
248-
3. Open a new Pull Request using the title 'Changelog entry for vX.Y.Z' with
248+
3. Open a new pull request using the title 'Changelog entry for vX.Y.Z' with
249249
the updated release notes, so that other people can help to review and
250250
collaborate on the changelog curation process described next.
251251
4. Edit the change list to remove any trivial changes (updates to the README,
@@ -256,7 +256,7 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html
256256
are alphabetical.
257257
6. Move a few important items from the main sections to the highlights section.
258258
7. Edit the list of people who contributed to the release, linking to their
259-
GitHub account. Sort their names by the number of commits made since the
259+
GitHub accounts. Sort their names by the number of commits made since the
260260
last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`).
261261
8. Update `README.rst` with new information on the new release version,
262262
including a vX.Y.Z documentation link, and compatibility with
@@ -270,7 +270,7 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html
270270
More information about the `CITATION.cff` specification can be found at
271271
https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
272272
273-
### Check the README syntax
273+
### Check the README Syntax
274274
275275
GitHub is a bit forgiving when it comes to the RST syntax in the README but PyPI is not.
276276
So slightly broken RST can cause the PyPI page to not render the correct content. Check
@@ -282,7 +282,7 @@ rst2html.py --no-raw README.rst > index.html
282282
283283
Open `index.html` and check for any flaws or error messages.
284284
285-
### Pushing to PyPI and updating the documentation
285+
### Pushing to PyPI and Updating the Documentation
286286
287287
After the changelog is updated, making a release can be done by going to
288288
https://github.com/GenericMappingTools/pygmt/releases, editing the draft release,
@@ -297,10 +297,10 @@ this new folder.
297297
298298
### Archiving on Zenodo
299299
300-
Grab both the source code and baseline images zip files from the GitHub release page
300+
Grab both the source code and baseline images ZIP files from the GitHub release page
301301
and upload them to Zenodo using the previously reserved DOI.
302302
303-
### Updating the conda package
303+
### Updating the Conda Package
304304
305305
When a new version is released on PyPI, conda-forge's bot automatically creates version
306306
updates for the feedstock. In most cases, the maintainers can simply merge that PR.

0 commit comments

Comments
 (0)