Skip to content

Commit 18a85af

Browse files
authored
Fix Python versions, typos and enhance clarity in CONTRIBUTING.md (#842)
Corrected minor grammatical errors and improved clarity throughout the document.
1 parent 901e1d8 commit 18a85af

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# So You Want to Contribute to Papermill!
22

3-
We welcome all contributions to Papermill both large and small. We encourage you to join our community.
3+
We welcome all contributions to Papermill, both large and small. We encourage you to join our community.
44

55
## Our Community Values
66

@@ -14,11 +14,11 @@ Please read our entire [Code of Conduct](https://github.com/nteract/nteract/blob
1414

1515
## Setting up Your Development Environment
1616

17-
Following these instructions should give you an efficient path to opening your first pull-request.
17+
Following these instructions should give you an efficient path to opening your first pull request.
1818

1919
### Cloning the Papermill Repository
2020

21-
Fork the repository to your local Github account. Clone this repository to your local development machine.
21+
Fork the repository to your local GitHub account. Clone this repository to your local development machine.
2222

2323
```bash
2424
git clone https://github.com/<your_account>/papermill
@@ -27,7 +27,7 @@ cd papermill
2727

2828
### Install an Editable Version
2929

30-
We prefer to use native venv to manage the development environment.
30+
We prefer to use a native virtual environment (venv) to manage the development environment.
3131

3232
```bash
3333
python3 -m venv dev
@@ -47,31 +47,31 @@ conda create -n dev
4747
. activate dev
4848
```
4949

50-
_Note: When you are finished you can use `source deactivate` to go back to your base environment._
50+
_Note: When you are finished, you can use `source deactivate` to go back to your base environment._
5151

5252
### Running Tests Locally
5353

54-
If you are contributing with documentation please jump to [building documentation.](#Building-Documentation)
54+
If you are contributing to documentation, please jump to [building documentation.](#Building-Documentation)
5555

56-
We need to install the development package before we can run the tests. If anything is confusing below, always resort to the relevant documentation.
56+
We need to install the development package before running the tests. If anything is unclear below, please refer to the relevant documentation.
5757

58-
For the most basic test runs against python 3.12 use this tox subset (callable after `pip install tox`):
58+
For the most basic test runs against Python 3.12, use this tox subset (callable after `pip install tox`):
5959

6060
```bash
6161
tox -e py312
6262
```
6363

64-
This will just execute the unittests against python 3.8 in a new virtual env. The first run will take longer to setup the virtualenv, but will be fast after that point.
64+
This will execute the unittests against Python 3.12 in a new virtual environment. The first run will take longer to set up the virtualenv, but will be fast after that point.
6565

66-
For a full test suite of all envs and linting checks simply run tox without any arguments
66+
To run the full test suite for all environments and linting checks, use the 'tox' command without any arguments.
6767

6868
```bash
6969
tox
7070
```
7171

72-
This will require python3.8, 3.9, 3.10, 3.11, and 3.12 to be installed.
72+
This will require Python 3.10, 3.11, 3.12, and 3.13 to be installed.
7373

74-
Alternavitely pytest can be used if you have an environment already setup which works or has custom packages not present in the tox build.
74+
Alternatively, pytest can be used if you have an environment already set up that works or has custom packages not present in the tox build.
7575

7676
```bash
7777
pytest
@@ -89,7 +89,7 @@ Once you are done editing, to generate the documentation, use tox and the follow
8989
tox -e docs
9090
```
9191

92-
This will generate `.html` files in the `/.tox/docs_out/` directory. Once you are satisfied, feel free to jump to the next section.
92+
This will generate `.html` files in the `/.tox/docs_out/` directory. Once you are satisfied, you can just jump to the next section.
9393

9494
## So You're Ready to Pull Request
9595

@@ -111,7 +111,7 @@ Run check manifest to ensure all files are accounted for in the repository.
111111
check-manifest
112112
```
113113

114-
This commands read the `MANIFEST.in` file and explicitly specify the files to include in the source distribution. You can read more about how this works [here](https://docs.python.org/3/distutils/sourcedist.html).
114+
This command read the `MANIFEST.in` file and explicitly specify the files to include in the source distribution. You can read more about how this works [here](https://docs.python.org/3/distutils/sourcedist.html).
115115

116116
### Push Changes to Forked Repo
117117

@@ -139,7 +139,7 @@ and ensure the remotes point to your GitHub. Don't work on the main branch!
139139

140140
### Create Pull Request
141141

142-
Follow [these](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) instrucutions to create a pull request from a forked repository. If you are submitting a bug-fix for a specific issue make sure to reference the issue in the pull request.
142+
Follow [these](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) instructions to create a pull request from a forked repository. If you are submitting a bug fix for a specific issue, ensure that you reference the issue in the pull request.
143143

144144
There are good references to the [Git documentation](https://git-scm.com/doc) and [Git workflows](https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html) for more information if any of this is unfamiliar.
145145

0 commit comments

Comments
 (0)