Skip to content

Commit

Permalink
Move bw policy where it belongs
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek committed Apr 16, 2024
1 parent d362c8d commit 79ceaa9
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 12 deletions.
3 changes: 3 additions & 0 deletions .github/SECURITY.md
Expand Up @@ -8,6 +8,9 @@ Therefore, we only support the latest version.
That said, you shouldn't be afraid to upgrade if you're only using our documented public APIs and pay attention to `DeprecationWarning`s.
Whenever there is a need to break compatibility, it is announced in the changelog and raises a `DeprecationWarning` for a year (if possible) before it's finally really broken.

> [!WARNING]
> What explicitly *may* change over time are the default hashing parameters and the behavior of the [CLI interface](https://argon2-cffi.readthedocs.io/en/stable/cli.html).

## Security contact information

Expand Down
13 changes: 1 addition & 12 deletions CHANGELOG.md
Expand Up @@ -8,18 +8,7 @@ The **first number** of the version is the year.
The **second number** is incremented with each release, starting at 1 for each year.
The **third number** is when we need to start branches for older releases (only for emergencies).

---

*argon2-cffi* has a very strong backwards-compatibility policy.
Generally speaking, you shouldn't ever be afraid of updating.

Whenever breaking changes are needed, they are:

1. …announced here in the changelog.
2. …the old behavior raises a `DeprecationWarning` for a year (if possible).
3. …are done with another announcement in the changelog.

What explicitly *may* change over time are the default hashing parameters and the behavior of the [CLI interface](https://argon2-cffi.readthedocs.io/en/stable/cli.html).
You can find our backwards-compatibility policy [here](https://github.com/hynek/argon2-cffi/blob/main/.github/SECURITY.md).

<!-- changelog follows -->

Expand Down

0 comments on commit 79ceaa9

Please sign in to comment.