Skip to content

Commit

Permalink
Chore: explain versioning system in README (#1652)
Browse files Browse the repository at this point in the history
  • Loading branch information
georgesittas authored May 18, 2023
1 parent fa7b195 commit 19a56d9
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Contributions are very welcome in SQLGlot; read the [contribution guide](https:/
## Table of Contents

* [Install](#install)
* [Versioning](#versioning)
* [Get in Touch](#get-in-touch)
* [Examples](#examples)
* [Formatting and Transpiling](#formatting-and-transpiling)
Expand Down Expand Up @@ -51,7 +52,16 @@ Requirements for development (optional):
make install-dev
```

## Versioning

Given a version number `MAJOR`.`MINOR`.`PATCH`, SQLGlot uses the following versioning strategy:

- The `PATCH` version is incremented when there are backwards-compatible fixes or feature additions.
- The `MINOR` version is incremented when there are backwards-incompatible fixes or feature additions.
- The `MAJOR` version is incremented when there are significant backwards-incompatible fixes or feature additions.

## Get in Touch

We'd love to hear from you. Join our community [Slack channel](https://tobikodata.com/slack)!

## Examples
Expand Down Expand Up @@ -436,6 +446,7 @@ user_id price
See also: [Writing a Python SQL engine from scratch](https://github.com/tobymao/sqlglot/blob/main/posts/python_sql_engine.md).

## Used By

* [SQLMesh](https://github.com/TobikoData/sqlmesh)
* [Fugue](https://github.com/fugue-project/fugue)
* [ibis](https://github.com/ibis-project/ibis)
Expand Down

0 comments on commit 19a56d9

Please sign in to comment.