Skip to content

Commit

Permalink
docs: document API stability
Browse files Browse the repository at this point in the history
Write down the guidelines we've been using to decide whether a breaking
change is acceptable or not.

Signed-off-by: Lorenz Bauer <lmb@isovalent.com>
  • Loading branch information
lmb committed Apr 11, 2023
1 parent e27d8ba commit dd8ab94
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ a better understanding for the high-level goals.
2. (*optional*) Create a draft PR if you want to discuss the implementation or have hit a problem. It's fine if this doesn't compile or contains debug statements.
3. Create a PR that is ready to merge. This must pass CI and have tests.

### API stability

The library doesn't guarantee the stability of its API at the moment.

1. If possible avoid breakage by introducing new API and deprecating the old one
at the same time. If an API was deprecated in v0.x it can be removed in v0.x+1.
2. Breaking API in a way that causes compilation failures is acceptable but must
have good reasons.
3. Changing the semantics of the API without causing compilation failures is
heavily discouraged.

## Running the tests

Many of the tests require privileges to set resource limits and load eBPF code.
Expand Down

0 comments on commit dd8ab94

Please sign in to comment.