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
Thank you for your interest in improving repo-man!
4
4
Please read these guidelines to see how best to contribute to the project's success.
5
5
6
6
## Source code issues
7
7
8
8
If you've discovered an issue with the code in this repository, please [open an issue](https://github.com/easy-as-python/repo-man/issues/new/choose).
9
-
Or, if you have time, please consider forking this repo and opening a pull request with the fix!
9
+
Or, if you have time, please consider forking this repository and opening a pull request with the fix!
10
10
11
11
## Questions
12
12
@@ -15,3 +15,27 @@ If you just have a question or would like to discuss ideas, [start a discussion]
15
15
## Code of conduct
16
16
17
17
Please read the [code of conduct](../CODE_OF_CONDUCT.md) before contributing to this repository.
18
+
19
+
## Local development
20
+
21
+
This section covers how to work with the project when developing changes locally.
22
+
23
+
### Running
24
+
25
+
To run repo-man as a command-line interface (CLI) locally, you need to install the package.
26
+
You can install the package in a Python virtual environment using your preferred method, or use [pipx](https://pipx.pypa.io/stable/).
27
+
You can use the `-e` flag in either pip or pipx to install repo-man from the project directory as an editable package so that any changes you make will be reflected the next time you use the CLI.
28
+
If using a virtual environment, be sure the environment is activated before trying to use the CLI so that the `repo-man` command will be on your `$PATH`.
29
+
30
+
### Testing
31
+
32
+
The test suite runs using [tox](https://tox.wiki).
33
+
You can install tox into the same virtual environment you use to install the project, or you can install tox using pipx as well.
34
+
Once you've installed tox, you can run the `tox` command in the root of the project to run unit tests with coverage.
35
+
36
+
### Linting, type checking, and formatting
37
+
38
+
Several other project development activities such as linting, type checking, and formatting are also available as tox environments.
39
+
You can see all available tasks in `setup.cfg`.
40
+
These will be run when you open a pull request, and the checks will fail if you haven't fixed any issues locally.
41
+
If this happens, run the tasks locally to find and fix any issues, then push your changes.
0 commit comments