Skip to content

Commit aeb0529

Browse files
authored
Merge pull request slgobinath#704 from deltragon/pr-template-comments-mypy
add instructions to run mypy to the PR template and readme
2 parents c1d5550 + 24ce609 commit aeb0529

File tree

2 files changed

+6
-0
lines changed

2 files changed

+6
-0
lines changed

.github/pull_request_template.md

+2
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
Describe your changes here, and link to related issues if available.
44

55
Reminder to run `python validate_po.py --extract` if you have added new translatable strings.
6+
7+
Reminder to run `ruff check`, `ruff format`, and `mypy safeeyes` to ensure coding standards are followed and types are correct.

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,10 @@ To ensure the new strings are well-formed, you can use `python validate_po.py --
202202

203203
To ensure that the coding and formatting guidelines are followed, install [ruff](https://docs.astral.sh/ruff/) and run `ruff check` and `ruff format --check` to check for issues, as well as `ruff check --fix` and `ruff format` to autofix them.
204204

205+
To ensure that any types are correct, install [mypy](https://github.com/python/mypy) and run `mypy safeeyes`.
206+
207+
The last three checks are also run in CI, so a PR must pass all the tests for it to be mmerged.
208+
205209
## How to Release?
206210

207211
0. Run `update-po.sh` to generate new translation files (which will be eventually updated by translators). Commit and push the changes to the master branch.

0 commit comments

Comments
 (0)