Skip to content

Commit

Permalink
Stability policy: permit exceptional changes for unformatted code (#3155
Browse files Browse the repository at this point in the history
)
  • Loading branch information
JelleZijlstra committed Jul 6, 2022
1 parent b859a37 commit 7af77d1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
3 changes: 3 additions & 0 deletions CHANGES.md
Expand Up @@ -27,6 +27,9 @@
<!-- Major changes to documentation and policies. Small docs changes
don't need a changelog entry. -->

- Reword the stability policy to say that we may, in rare cases, make changes that
affect code that was not previously formatted by _Black_ (#3155)

### Integrations

<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
Expand Down
15 changes: 9 additions & 6 deletions docs/the_black_code_style/index.md
Expand Up @@ -24,13 +24,16 @@ below. Ongoing style considerations are tracked on GitHub with the
The following policy applies for the _Black_ code style, in non pre-release versions of
_Black_:

- The same code, formatted with the same options, will produce the same output for all
releases in a given calendar year.
- If code has been formatted with _Black_, it will remain unchanged when formatted with
the same options using any other release in the same calendar year.

This means projects can safely use `black ~= 22.0` without worrying about major
formatting changes disrupting their project in 2022. We may still fix bugs where
_Black_ crashes on some code, and make other improvements that do not affect
formatting.
This means projects can safely use `black ~= 22.0` without worrying about formatting
changes disrupting their project in 2022. We may still fix bugs where _Black_ crashes
on some code, and make other improvements that do not affect formatting.

In rare cases, we may make changes affecting code that has not been previously
formatted with _Black_. For example, we have had bugs where we accidentally removed
some comments. Such bugs can be fixed without breaking the stability policy.

- The first release in a new calendar year _may_ contain formatting changes, although
these will be minimised as much as possible. This is to allow for improved formatting
Expand Down

0 comments on commit 7af77d1

Please sign in to comment.