Skip to content

Commit c01c54a

Browse files
authored
Add contribution docs for local dev (#18)
* Add contribution docs on local dev * Fix GitHub releases artifact names
1 parent 1bbb478 commit c01c54a

2 files changed

Lines changed: 29 additions & 5 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Contributing to Publishing Python Packages
1+
# Contributing to repo-man
22

3-
Thank you for your interest in improving repoman!
3+
Thank you for your interest in improving repo-man!
44
Please read these guidelines to see how best to contribute to the project's success.
55

66
## Source code issues
77

88
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!
1010

1111
## Questions
1212

@@ -15,3 +15,27 @@ If you just have a question or would like to discuss ideas, [start a discussion]
1515
## Code of conduct
1616

1717
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.

.github/workflows/packaging.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ jobs:
145145
uses: softprops/action-gh-release@v1
146146
with:
147147
files: |
148-
dist/repoman-*.whl
149-
dist/repoman-*.tar.gz
148+
dist/repo-man-*.whl
149+
dist/repo_man-*.tar.gz
150150
env:
151151
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)