You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/maintenance.md
+37-32
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,7 @@ communication tools we use.
19
19
20
20
- Added to the [pygmt-contributors team](https://github.com/orgs/GenericMappingTools/teams/pygmt-contributors) (gives 'write' permission to the repository)
21
21
- Added as collaborator on [DAGsHub](https://dagshub.com/GenericMappingTools/pygmt/settings/collaboration) (gives 'write' permission to dvc remote storage)
22
+
- Added to the {doc}`Team Gallery page <team>`
22
23
- Added as member on the [PyGMT devs Slack channel](https://pygmtdevs.slack.com) (for casual conversations)
23
24
- Added as member on [HackMD](https://hackmd.io/@pygmt) (for draft announcements) [optional]
24
25
@@ -86,33 +87,34 @@ The main advantages of this are:
86
87
87
88
We use GitHub Actions continuous integration (CI) services to build, test and
88
89
manage the project on Linux, macOS and Windows. The GitHub Actions CI are
89
-
controlled by 14 workflow files located in `.github/workflows`. Here we briefly
90
+
controlled by workflow files located in `.github/workflows`. Here we briefly
90
91
summarize the functions of the workflows. Please refer to the comments in the
91
92
workflow files for more details.
92
93
93
-
1.`style_checks.yaml`: Code lint and style checks
94
-
2.`check-links.yml`: Check links in the repository and documentation
95
-
3.`ci_tests.yaml`: Run regular PyGMT tests on Linux/macOS/Windows
96
-
4.`ci_tests_dev.yaml`: Run regular PyGMT tests with GMT dev version on Linux/macOS/Windows
97
-
5.`ci_tests_legacy.yaml`: Run regular PyGMT tests with GMT legacy versions on Linux/macOS/Windows
98
-
6.`ci_docs.yml`: Build documentation on Linux/macOS/Windows and deploy to GitHub
99
-
7.`ci_doctest.yaml`: Run all doctests on Linux/macOS/Windows
100
-
8.`cache_data.yaml`: Cache GMT remote data files and uplodas as artifacts
101
-
9.`publish-to-pypi.yml`: Publish archives to PyPI and TestPyPI
102
-
10.`release-drafter.yml`: Draft the next release notes
103
-
11.`release-baseline-images.yml`: Upload the ZIP archive of baseline images as a release asset
104
-
12.`format-command.yml`: Format the codes using slash command
105
-
13.`dvc-diff.yml`: Report changes in test images
106
-
14.`slash-command-dispatch.yml`: Support slash commands in pull requests
107
-
15.`benchmarks.yml`: Benchmarks the execution speed of tests to track performance of PyGMT functions
94
+
-`style_checks.yaml`: Code lint and style checks
95
+
-`type_checks.yml`: Static type checks
96
+
-`check-links.yml`: Check links in the repository and documentation
97
+
-`ci_tests.yaml`: Run regular PyGMT tests on Linux/macOS/Windows
98
+
-`ci_tests_dev.yaml`: Run regular PyGMT tests with GMT dev version on Linux/macOS/Windows
99
+
-`ci_tests_legacy.yaml`: Run regular PyGMT tests with GMT legacy versions on Linux/macOS/Windows
100
+
-`ci_docs.yml`: Build documentation on Linux/macOS/Windows and deploy to GitHub
101
+
-`ci_doctest.yaml`: Run all doctests on Linux/macOS/Windows
102
+
-`cache_data.yaml`: Cache GMT remote data files and uplodas as artifacts
103
+
-`publish-to-pypi.yml`: Publish archives to PyPI and TestPyPI
104
+
-`release-drafter.yml`: Draft the next release notes
105
+
-`release-baseline-images.yml`: Upload the ZIP archive of baseline images as a release asset
106
+
-`format-command.yml`: Format the codes using slash command
107
+
-`dvc-diff.yml`: Report changes in test images
108
+
-`slash-command-dispatch.yml`: Support slash commands in pull requests
109
+
-`benchmarks.yml`: Benchmarks the execution speed of tests to track performance of PyGMT functions
108
110
109
111
110
112
## Continuous Documentation
111
113
112
114
We use the [ReadtheDocs](https://readthedocs.org/) service to preview changes
113
115
made to our documentation website every time we make a commit in a pull request.
114
116
The service has a configuration file `.readthedocs.yaml`, with a list of options
115
-
to change the default behaviour at https://docs.readthedocs.io/en/stable/config-file/index.html.
117
+
to change the default behaviour at <https://docs.readthedocs.io/en/stable/config-file/index.html>.
116
118
117
119
118
120
## Dependencies Policy
@@ -134,7 +136,8 @@ adjusted upward on every major and minor release, but never on a patch release.
134
136
135
137
PyGMT is still undergoing rapid development. All of the API is subject to change
136
138
until the v1.0.0 release. Versioning in PyGMT is based on the
0 commit comments