@@ -24,7 +24,7 @@ instead.
24
24
branch are in the ` dev ` folder. Pages for each release are in their own folders.
25
25
** Automatically updated by GitHub Actions** so you shouldn't have to make commits here.
26
26
27
- ## Managing GitHub issues
27
+ ## Managing GitHub Issues
28
28
29
29
A few guidelines for managing GitHub issues:
30
30
@@ -40,7 +40,7 @@ A few guidelines for managing GitHub issues:
40
40
possible, post a comment when an upstream PR is merged that fixes the problem, and
41
41
consider adding a regression test for serious bugs.
42
42
43
- ## Reviewing and merging pull requests
43
+ ## Reviewing and Merging Pull Requests
44
44
45
45
A few guidelines for reviewing:
46
46
@@ -73,15 +73,15 @@ There are 11 configuration files located in `.github/workflows`:
73
73
74
74
1 . ` style_checks.yaml ` (Code lint and style checks)
75
75
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.
77
77
It is also scheduled to run daily on the * main* branch.
78
78
79
79
2 . ` ci_tests.yaml ` (Tests on Linux/macOS/Windows)
80
80
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.
82
82
It is also scheduled to run regular tests daily and run full tests
83
83
(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
85
85
Continuous Integration resources:
86
86
87
87
- Minimum [ NEP29] ( https://numpy.org/neps/nep-0029-deprecation_policy )
@@ -95,8 +95,8 @@ There are 11 configuration files located in `.github/workflows`:
95
95
96
96
3 . ` ci_docs.yml ` (Build documentation on Linux/macOS/Windows)
97
97
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
100
100
Continuous Integration resources.
101
101
102
102
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
172
172
adjusted upward on every major and minor release, but never on a patch release.
173
173
174
174
175
- ## Backwards compatibility and deprecation policy
175
+ ## Backwards Compatibility and Deprecation Policy
176
176
177
177
PyGMT is still undergoing rapid development. All of the API is subject to change
178
178
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
221
221
obtained from git.
222
222
There are a few steps that still must be done manually, though.
223
223
224
- ### Updating the changelog
224
+ ### Updating the Changelog
225
225
226
226
The Release Drafter GitHub Action will automatically keep a draft changelog at
227
227
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.
229
229
This release drafter tool has two configuration files, one for the GitHub Action
230
230
at .github/workflows/release-drafter.yml, and one for the changelog template
231
231
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
245
245
```
246
246
[](https://doi.org/10.5281/zenodo.<INSERT-DOI-HERE>)
247
247
```
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
249
249
the updated release notes, so that other people can help to review and
250
250
collaborate on the changelog curation process described next.
251
251
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
256
256
are alphabetical.
257
257
6. Move a few important items from the main sections to the highlights section.
258
258
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
260
260
last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`).
261
261
8. Update `README.rst` with new information on the new release version,
262
262
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
270
270
More information about the `CITATION.cff` specification can be found at
271
271
https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
272
272
273
- ### Check the README syntax
273
+ ### Check the README Syntax
274
274
275
275
GitHub is a bit forgiving when it comes to the RST syntax in the README but PyPI is not.
276
276
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
282
282
283
283
Open `index.html` and check for any flaws or error messages.
284
284
285
- ### Pushing to PyPI and updating the documentation
285
+ ### Pushing to PyPI and Updating the Documentation
286
286
287
287
After the changelog is updated, making a release can be done by going to
288
288
https://github.com/GenericMappingTools/pygmt/releases, editing the draft release,
@@ -297,10 +297,10 @@ this new folder.
297
297
298
298
### Archiving on Zenodo
299
299
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
301
301
and upload them to Zenodo using the previously reserved DOI.
302
302
303
- ### Updating the conda package
303
+ ### Updating the Conda Package
304
304
305
305
When a new version is released on PyPI, conda-forge's bot automatically creates version
306
306
updates for the feedstock. In most cases, the maintainers can simply merge that PR.
0 commit comments