Skip to content

Commit d8a2704

Browse files
authored
Copyedits for grammar and standardization
1 parent 21d8913 commit d8a2704

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ details how to contribute in a standardized and efficient manner.
88

99
## Git Workflow Summary
1010

11-
- Ensure that you've opened an Issue on Github and consensus around the
12-
solution has be reached.
11+
- Ensure that you've opened an Issue on GitHub and consensus around the
12+
solution has been reached.
1313
- Minor changes (e.g., grammatical fixes) do not require an Issue first.
14-
- Make a new branch for each separable set of changes["one task, one
15-
branch"](https://mail.python.org/pipermail/ipython-dev/2010-October/005632.html).
16-
- [Each commit should make one change](https://dev.to/ruanbrandao/how-to-make-good-git-commits-256k).
17-
to aide reviewing and (in the worst case) simplify reverting it in the future.
14+
- Make a new branch for each separable set of changes["one task, one
15+
branch."](https://mail.python.org/pipermail/ipython-dev/2010-October/005632.html).
16+
- [Each commit should make one change](https://dev.to/ruanbrandao/how-to-make-good-git-commits-256k)
17+
to aid reviewing and (in the worst case) simplify reverting it in the future.
1818
- A patch commit message should consist of a single short (less than 50
1919
character) sentence summarizing the change, optionally followed by a blank line
2020
and then a more thorough description.
@@ -25,16 +25,16 @@ details how to contribute in a standardized and efficient manner.
2525
- If you do find yourself merging from upstream, consider [Rebasing on
2626
upstream](https://matplotlib.org/stable/devel/gitwash/development_workflow.html#rebase-on-trunk).
2727
- Submit a Pull Request from your feature branch against upstream.
28-
- Use the Draft PR feature on Github or title your PR with `WIP` if your PR is
28+
- Use the Draft PR feature on GitHub or title your PR with `WIP` if your PR is
2929
not ready for a complete review immediately upon submission.
30-
- Ask on the [Exaworks slack](https://exaworks.slack.com) if you get stuck.
30+
- Ask on the [Exaworks Slack](https://exaworks.slack.com) if you get stuck.
3131

3232

3333
## Pull Request (PR) Merging Process
3434

3535
- PR reviews should be timely. Both reviewer and PR issuer should make a good
3636
attempt at resolving the conversation as quickly as possible.
37-
- PR reviews exist to check obvious things aren't missed, not to achieve
37+
- PR reviews exist to check that obvious things aren't missed, not to achieve
3838
perfection.
3939
- A PR is eligible for merging if it has at least one approval from a
4040
project maintainer, no outstanding requested changes or discussions, and passes
@@ -55,16 +55,16 @@ under-the-hood. PEP8 compliance is also verified as part of the CI by `flake8`.
5555

5656
## Type Annotations
5757

58-
As much python code in this repo as is feasible should include type annotations.
58+
As much Python code in this repo as is feasible should include type annotations.
5959
These type annotations can then be ingested and checked by `mypy`, which can be
6060
run with `make typecheck` and `make checks`.
6161

6262
## Docstrings
6363

64-
As many public python interfaces in this repo as is feasible should
64+
As many public Python interfaces in this repo as is feasible should
6565
include docstring documentation. All docstrings should follow the
6666
[numpy format](https://numpydoc.readthedocs.io/en/latest/format.html). These
6767
docstrings are automatically parsed by Sphinx and turned into html-based
6868
documentation hosted on readthedocs. Document generation can be run locally
6969
with `make docs`. For more details about building the documentation, please
70-
see [`README-dev`][README-dev.md].
70+
see [`README-dev`](README-dev.md).

0 commit comments

Comments
 (0)