Skip to content

Commit

Permalink
Change description of version numbers (WIP)
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyMcCormick committed Dec 11, 2024
1 parent 132826d commit fb846a3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@ Usage of semantic versioning is recommended, which defines a version like `MAJOR

Semantic versioning typically follows the following generic guidelines:

- `MAJOR`: Breaking changes that are not backward compatible.
- `MINOR`: Backward-compatible changes.
- `PATCH`: Backward-compatible changes, typically those that do not change the database schema.
- Different `MAJOR` versions are not compatible.
- Different `MINOR` versions are backward-compatible.
- Different `PATCH` versions are completely compatible.

These rules would typically not be followed strictly for schema changes. For instance, some operations which are technically backward compatible, such as adding a table, should likely result in a `MAJOR` version increment rather than `MINOR`, as they constitute an important and significant update which would usually require major updates to client queries and APIs.

Expand Down

0 comments on commit fb846a3

Please sign in to comment.