Skip to content

Commit

Permalink
add contribution section and unittest calls to README
Browse files Browse the repository at this point in the history
  • Loading branch information
brainelectronics committed Oct 25, 2022
1 parent 3e412e3 commit c9c7c0e
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Create version info files based on the latest changelog entry.
- [Custom regular expressions](#custom-regular-expressions)
- [Custom template file](#custom-template-file)
- [Additional version info content](#additional-version-info-content)
- [Contributing](#contributing)
- [Unittests](#unittests)
- [Credits](#credits)

<!-- /MarkdownTOC -->
Expand Down Expand Up @@ -235,6 +237,33 @@ __version__ = '.'.join(__version_info__) + '-rc1234'
```

## Contributing

### Unittests

Run the unittests locally with the following command after installing this
package in a virtual environment or by using `tox` to create one on each run.

```bash
# install the package with all its development dependencies
pip install .[dev]

# run all tests
nose2 --config tests/unittest.cfg

# run only one specific tests
nose2 tests.test_extract_version.TestExtractVersion.test_version_line_regex
```

Generate the coverage files with

```bash
python create_report_dirs.py
coverage html
```

The coverage report is placed at `reports/coverage/html/index.html`

## Credits

Based on the [PyPa sample project][ref-pypa-sample]. Also a big thank you to
Expand Down

0 comments on commit c9c7c0e

Please sign in to comment.