Skip to content

Conversation

@riverma
Copy link
Collaborator

@riverma riverma commented Jun 16, 2025

Purpose

Proposed Changes

  • [ADD] New versioning guide at /docs/guides/software-lifecycle/versioning/README.mdx
  • [ADD] Versioning guide entry to slim-registry.json with appropriate tags and Commitizen package asset
  • [CHANGE] Pull requests guide versioning section to reference new dedicated guide with key takeaways for PR workflows
  • [CHANGE] Change log guide prerequisites to reference new versioning guide
  • [REMOVE] Detailed versioning content from pull-requests guide (ported to new dedicated guide)

Issues

Testing

  • Viewed new guide in local rendering
  • Verified site builds using yarn build

riverma added 2 commits June 15, 2025 18:23
Changes made to other relevant guides to reference this guide
@riverma riverma requested review from a team and anilnatha June 16, 2025 01:35
@riverma riverma self-assigned this Jun 16, 2025
@riverma riverma added most requested Highly requested by community members medium complexity Ticket is relatively straightforward but may have a difficult sub-task software lifecycle Process improvements involving developing, testing, integrating, deploying software labels Jun 16, 2025
@riverma riverma moved this to 👀 In Review in SLIM Planning Board Jun 16, 2025
@riverma riverma marked this pull request as ready for review June 16, 2025 01:35
@riverma riverma changed the title feat: New guide on versioning New guide on versioning Jun 16, 2025
@riverma
Copy link
Collaborator Author

riverma commented Jun 16, 2025

@anilnatha - what do you think? I made a new recommendation for the commitizen tool in this guide, which I think can help developers use conventional commits (useful for future automated releases). Also, pointed your existing Pull Request guide's versioning section to this guide.


## Wrapping it All Together

```mermaid

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A mermaid chart? Awesome! 🎉

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Here's a rendering for those interested:

graph TD
    A[Start Project] --> B[Install Commitizen]
    B --> C[Run cz init]
    
    C --> F{Making Changes}
    F --> G[cz commit]
    G --> H[Push to Branch]
    H --> I[Create Pull Request]
    I --> J[Review Commits]
    J --> K{Ready to Release?}
    
    K -->|No| F
    K -->|Yes| L[cz bump]
    L --> M[Update CHANGELOG.md]
    M --> N[Mark Release]
    N --> P[CI/CD Pipeline]
    P --> Q[Release Published]
    Q --> F
Loading

Copy link

@nutjob4life nutjob4life left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Nice work @anilnatha and @riverma 👍

@riverma
Copy link
Collaborator Author

riverma commented Jun 17, 2025

LGTM! Nice work @anilnatha and @riverma 👍

Thanks for looking this over @nutjob4life! Appreciate your feedback and 👀 !

@sonarqubecloud
Copy link

Copy link
Contributor

@anilnatha anilnatha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These additions are awesome! Thanks for completing these additions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

medium complexity Ticket is relatively straightforward but may have a difficult sub-task most requested Highly requested by community members software lifecycle Process improvements involving developing, testing, integrating, deploying software

Projects

Status: 👀 In Review

Development

Successfully merging this pull request may close these issues.

[New Best Practice Guide]: Versioning Guide

4 participants