Users/zhaodongwang/standardize versioning #91
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request establishes comprehensive versioning and release management standards for the Microsoft Dataverse SDK for Python project. It introduces clear guidelines for contributors and maintainers, adopting industry-standard practices from Semantic Versioning and Keep a Changelog.
Changes:
- Added Development Guidelines section to CONTRIBUTING.md covering Semantic Versioning practices, changelog maintenance process, and git tagging/release procedures
- Updated CHANGELOG.md to follow the Keep a Changelog format and added version comparison links
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Added comprehensive versioning, changelog, and release guidelines with examples for maintainers and contributors |
| CHANGELOG.md | Reformatted to follow Keep a Changelog standard, streamlined existing entry, and added version comparison links |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
anbha-msft
approved these changes
Jan 30, 2026
tpellissier-msft
approved these changes
Jan 30, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
added major/minor versioning and release standards (for release update CHANGELOG.md, create new github tag and github release
Copilot summary:
This pull request improves project documentation by introducing clear versioning and changelog guidelines for contributors and maintainers. It also updates the
CHANGELOG.mdto follow the "Keep a Changelog" format and adds version comparison links for easier release tracking.Documentation and Process Improvements:
Added a "Development Guidelines" section to
CONTRIBUTING.mdwith instructions on Semantic Versioning, changelog maintenance, and release tagging, making the contribution and release process more transparent and standardized.Updated
CHANGELOG.mdto follow the "Keep a Changelog" format and Semantic Versioning, and added version comparison links at the bottom for easier navigation between releases.