Skip to content
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.

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

move BC policy into documentation #309

Merged
merged 2 commits into from
Feb 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 0 additions & 11 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
# Security Policy

## Supported Versions

We support only the latest version of Ragna, and we use [SemVer](https://semver.org/)
for versioning. As an early-stage project, we do not guarantee backwards compatibility
for minor versions until the 1.0 release.

You should feel comfortable upgrading if you're 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](docs/references/changelog.md) and will raise a
`DeprecationWarning` before it's finally really broken.

## Reporting a Vulnerability

If you think you found a vulnerability, please report it at
Expand Down
11 changes: 11 additions & 0 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,14 @@ pip install --upgrade ragna
```
ragna --version
```

## Backwards compatibility

As an early-stage project and as long as we are on a `0.` version, we allow ourselves
the **option to break backwards compatibility**. This is done to accommodate feature
requests that require large refactorings, which inadvertently happen in the beginning.
The amount and severity of the breaking changes should diminish as the project matures.
All such changes will be announced in the [release notes](references/release-notes.md).
At some point, we'll release a `1.0.0` version and switch to
[SemVer](https://semver.org/), imposing strict backwards compatibility rules onto
ourselves.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renaming to align the file name with its header

# Release notes

File renamed without changes.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,4 @@ nav:
- "references/rest-api.md"
- "references/cli.md"
- "references/faq.md"
- "references/changelog.md"
- "references/release-notes.md"
Loading