Skip to content

Commit

Permalink
chore: suit review
Browse files Browse the repository at this point in the history
  • Loading branch information
clintval committed Jan 17, 2025
1 parent e291031 commit 2503fdc
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Use `mkdocs` to build and serve the documentation.
poetry run mkdocs build && poetry run mkdocs serve
```

## Creating a Release on PyPi
## Creating a Release on PyPI

1. Clone the repository recursively and ensure you are on the `main` (un-dirty) branch
2. Checkout a new branch to prepare the library for release
Expand All @@ -147,7 +147,7 @@ GitHub Actions will take care of the remainder of the deployment and release pro
1. Unit tests will be run for safety-sake
2. A source distribution will be built
3. Multi-arch multi-Python binary distributions will be built
4. Assets will be deployed to PyPi with the new SemVer
4. Assets will be deployed to PyPI with the new SemVer
5. A [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)-aware changelog will be drafted
6. A GitHub release will be created with the new SemVer and the drafted changelog

Expand Down
10 changes: 9 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@ fix-and-check-all.sequence = [
[tool.mypy]
files = ["prymer", "tests"]
strict_optional = false
# TODO: activate the following checks!
# strict_optional = true
# strict_equality = true
check_untyped_defs = true
disallow_incomplete_defs = true
disallow_untyped_calls = true
Expand All @@ -119,6 +122,11 @@ warn_unreachable = true
warn_unused_configs = true
warn_unused_ignores = true
exclude = ["site/", "docs/"]
# TODO: activate the following checks!
# enable_error_code = [
# "ignore-without-code",
# "possibly-undefined",
# ]

[[tool.mypy.overrides]]
module = ["primer3"]
Expand Down Expand Up @@ -148,7 +156,7 @@ testpaths = [
[tool.ruff]
include = ["prymer/**/*.py", "tests/**/*.py"]
line-length = 100
target-version = "py312"
target-version = "py311"
output-format = "full"

[tool.ruff.lint]
Expand Down

0 comments on commit 2503fdc

Please sign in to comment.