Skip to content

Commit

Permalink
lib: Document stability guarantee
Browse files Browse the repository at this point in the history
Could be better, but this is a good start
  • Loading branch information
infinisil committed Jun 26, 2024
1 parent 10f928a commit a2e6a67
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions lib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ Don't have multiple changes in one PR, instead split it up into multiple ones.

This keeps the conversation focused and has a higher chance of getting merged.

### Ensure backwards compatibility

`lib` is the effective standard library for Nix, both for Nixpkgs and third-parties.
Because of that it's important to make sure that the interface isn't changed in a breaking way.

The only exceptions are:
- Breaking changes to interfaces that aren't in a release yet
- Breaking changes that are unlikely to cause problems for users
- Removal of functions that have been deprecated for at least one release
- Breaking changes to functions/sub-libraries that are explicitly marked as experimental

### Name the interface appropriately

When introducing new names to the interface, such as new function, or new function attributes,
Expand Down

0 comments on commit a2e6a67

Please sign in to comment.