Skip to content

Commit bbd5b0a

Browse files
committed
Updated links in CONTRIBUTING.md
1 parent ac6a3b8 commit bbd5b0a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When making changes, we try to follow the procedure below.
2929
**Note: as of 2025-11-11, we are stillin the process of making `pcpostprocess` confirm to this rule.**
3030

3131
4. **Discuss code in a PR**
32-
When your code is finished, or warrants discussion, create a [pull request](https://help.github.com/articles/about-pull-requests/) (PR).
32+
When your code is finished, or warrants discussion, create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) (PR).
3333
In your branch, update the [Changelog](./CHANGELOG.md) with a link to this PR and a concise summary of the changes.
3434
Finally, request a review of the code.
3535

@@ -75,13 +75,13 @@ Isort is configured in [pyproject.toml](./pyproject.toml) under the section `too
7575

7676
## Documentation
7777

78-
[#60](https://github.com/CardiacModelling/pcpostprocess/issues/60)
79-
8078
Every method and every class should have a [docstring](https://www.python.org/dev/peps/pep-0257/) that describes in plain terms what it does, and what the expected input and output is.
8179

8280
Each docstring should start with a one-line explanation.
8381
If more explanation is needed, this one-liner is followed by a blank line and more information in the following paragraphs.
8482

83+
**TODO: READTHEDOCS [#60](https://github.com/CardiacModelling/pcpostprocess/issues/60)**
84+
8585
**TODO: SYNTAX, RUNNING LOCALLY, ETC**
8686

8787
**TODO: EXAMPLES**
@@ -110,15 +110,15 @@ $ python3 -m unittest TestClass.test_method
110110

111111
### Unit tests
112112

113-
Testing is done with [unittest](https://docs.python.org/3.9/library/unittest.html).
113+
Testing is done with [unittest](https://docs.python.org/3/library/unittest.html).
114114

115115
Each method in `pcpostprocess` should have a unit test.
116116

117117
Tests should always aim to compare generated output with reference values, instead of just checking no errors are generated.
118118

119119
### Coverage
120120

121-
Coverage is checked with [coverage](https://coverage.readthedocs.io/en/7.11.3/).
121+
Coverage is checked with [coverage](https://coverage.readthedocs.io/en/latest/).
122122

123123
To run locally, use
124124
```

0 commit comments

Comments
 (0)