Skip to content

Explain in CONTRIBUTING.md about using --apply with format-incremental #1301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mhucka wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −4
Open

Explain in CONTRIBUTING.md about using --apply with format-incremental #1301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,14 +249,21 @@ make Mypy run in parallel for a substantial speed increase.

Code should meet common style standards for Python and be free of error-prone constructs. We use
[Pylint](https://www.pylint.org/) to check for code lint and [Black](https://github.com/psf/black)
for formatting code.
for formatting code, and provide scripts to run them.

* To check that code is formatted properly after editing Python files:

```shell
check/format-incremental
```

If formatting issues are reported, you can fix them automatically by running the script with
the `--apply` option:

```shell
check/format-incremental --apply
```

* To run the linter:

```shell
Expand Down Expand Up @@ -289,8 +296,8 @@ We use [pytest](https://docs.pytest.org) to run our tests and
`pytest -m "not slow" PATH`, where `PATH` is a directory or pytest file to test.

* After finishing a task, run `check/pytest` to test all of the OpenFermion code. If your system
has multiple processor cores, you can add the option `-n auto` to make it run in parallel for a
substantial speed increase. (Beware, though, that this is resource-intensive.)
has multiple processor cores, you can add the option `-n auto` to make pytest use multiple
parallel processes for a speed increase. (Beware, though, that this is resource-intensive.)

We don't require 100% coverage, but coverage should be very high, and any uncovered code must be
annotated with `# pragma: no cover`. To ignore coverage of a single line, place `# pragma: no cover`
Expand All @@ -301,7 +308,7 @@ cover` comment on its own line. Note, however, that these annotations should be

After a task is finished, run each of the following to make sure everything passes all the tests:

* `check/format-incremental`
* `check/format-incremental` (and `check/format-incremental --apply` to auto-fix format problems)
* `check/pylint -j 0`
* `check/mypy`
* `check/pytest -n auto`
Expand Down