Skip to content

Commit 5ec2229

Browse files
docs(README.md): Add versioning policy
1 parent f566e7e commit 5ec2229

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -452,6 +452,14 @@ A string with a name for type map variable, must be valid python identifier.
452452
Defaults to `"type_map"`. Used only if target is a Python file.
453453

454454

455+
---
456+
457+
## Versioning policy ##
458+
`ariadne-codegen` follows a custom versioning scheme where the minor version increases for breaking changes, while the patch version increments for bug fixes, enhancements, and other non-breaking updates.
459+
460+
Since `ariadne-codegen` has not yet reached a stable API, this approach is in place until version 1.0.0. Once the API stabilizes, the project will adopt [Semantic Versioning](https://semver.org/)..
461+
462+
455463
## Contributing
456464

457465
We welcome all contributions to Ariadne! If you've found a bug or issue, feel free to use [GitHub issues](https://github.com/mirumee/ariadne-codegen/issues). If you have any questions or feedback, don't hesitate to catch us on [GitHub discussions](https://github.com/mirumee/ariadne/discussions/).

0 commit comments

Comments
 (0)