feat(versioning): add initial versioning documentation with auto-gene…

[electron271]

…rated examples

Summary by Sourcery

Add versioning documentation explaining the project's version numbering approach and auto-generated version examples

New Features:

• Introduce detailed documentation for version generation, including examples for different branching scenarios

Documentation:

• Create a comprehensive VERSIONING.md document that explains the project's version numbering scheme based on PEP 440 and SemVer

[trunk-io]

⏱️ 15m total CI duration on this PR

Job	Cumulative Duration	Recent Runs
pyright	5m	🟩 🟩 🟩 🟩 🟩 (+2 more)
Analyze (python)	4m	🟩 🟩 🟩 🟩
docker	4m	🟥 🟥 🟩 🟩
Ruff	3m	🟩 🟩 🟩 🟩 🟩 (+2 more)

_{settings ⋅ feedback ⋅ docs ⋅ learn more about trunk.io}

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces initial versioning documentation, including auto-generated examples and an explanation of the versioning scheme. The documentation covers scenarios for both main and non-main branches, with and without commits since the last tag. It also clarifies the use of PEP 440 and SemVer.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added initial versioning documentation with auto-generated examples.	Added a VERSIONING.md file. Documented the auto-generated version examples for different scenarios (non-main branch with commits, main branch with commits, main branch without commits). Explained the versioning scheme, mentioning PEP 440 and SemVer.	VERSIONING.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @electron271 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a link to the PEP 440 specification for readers who want to learn more.
• It might be helpful to include a brief explanation of why .dev(NUMBER) is not allowed.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}