Skip to content

docs: enhance documentation for semantic versioning and changelog standards#53

Merged
gsinghjay merged 2 commits intomainfrom
docs/update-workflow
Jan 2, 2025
Merged

docs: enhance documentation for semantic versioning and changelog standards#53
gsinghjay merged 2 commits intomainfrom
docs/update-workflow

Conversation

@gsinghjay
Copy link
Owner

Description

This PR enhances our documentation by adding comprehensive sections about our versioning and changelog standards.

Added

  • Semantic Versioning (SemVer) principles and rules
  • Keep a Changelog guidelines and best practices
  • Python Semantic Release configuration details
  • Integration between tools and standards

Changed

  • Updated author information in pyproject.toml
  • Improved documentation structure and readability

Documentation Updates

  • Added version bumping rules with commit type mappings
  • Added changelog guidelines with practical examples
  • Detailed explanation of automated release process
  • Added configuration documentation with inline comments

Checklist

  • Documentation is clear and comprehensive
  • Configuration examples are accurate
  • Commit messages follow conventional commits
  • No code changes (documentation only)

Related Issues

N/A

Additional Notes

This documentation will help contributors understand:

  • How version numbers are determined from commits
  • How changelog entries are automatically generated
  • How our tools work together for automated releases

@gsinghjay gsinghjay merged commit 4a7df38 into main Jan 2, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant