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
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.
31
31
32
32
```bash
33
33
python3 -m venv dev
@@ -47,31 +47,31 @@ conda create -n dev
47
47
. activate dev
48
48
```
49
49
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._
51
51
52
52
### Running Tests Locally
53
53
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)
55
55
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.
57
57
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`):
59
59
60
60
```bash
61
61
tox -e py312
62
62
```
63
63
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.
65
65
66
-
For a full test suite of all envs and linting checks simply run toxwithout any arguments
66
+
To run the full test suite for all environments and linting checks, use the 'tox' command without any arguments.
67
67
68
68
```bash
69
69
tox
70
70
```
71
71
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.
73
73
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.
75
75
76
76
```bash
77
77
pytest
@@ -89,7 +89,7 @@ Once you are done editing, to generate the documentation, use tox and the follow
89
89
tox -e docs
90
90
```
91
91
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.
93
93
94
94
## So You're Ready to Pull Request
95
95
@@ -111,7 +111,7 @@ Run check manifest to ensure all files are accounted for in the repository.
111
111
check-manifest
112
112
```
113
113
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).
115
115
116
116
### Push Changes to Forked Repo
117
117
@@ -139,7 +139,7 @@ and ensure the remotes point to your GitHub. Don't work on the main branch!
139
139
140
140
### Create Pull Request
141
141
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 bugfix for a specific issue, ensure that you reference the issue in the pull request.
143
143
144
144
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.
0 commit comments