Update changelog guidelines #8395
Merged
Conversation
This file contains 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
idanovo
added
exclude-changelog
|
♻️ PR Preview fbeac8f has been successfully destroyed since this PR has been closed.
🤖 By surge-preview |
E2E Test Results - Quickstart |
E2E Test Results - DynamoDB Local - Local Block Adapter |
N-o-Z
requested changes
Nov 24, 2024
docs/project/contributing.md
Outdated
| 1. Database schema changes: Modifications to the data structure that don't alter the user interface. | ||
| 1. Development tooling updates: Changes to build processes or development environments. | ||
| 1. Internal API modifications: Alterations to internal APIs that don't affect the public-facing functionality. | ||
| 1. Documentation updates: Changes to the project's documentation that don't impact the user experience. |
There was a problem hiding this comment.
Suggested change
| 1. Documentation updates: Changes to the project's documentation that don't impact the user experience. | |
| 1. Documentation updates |
docs/project/contributing.md
Outdated
| 1. New features: Adding functionality that users can directly interact with. | ||
| 1. Configuration changes: Updates to settings that users can adjust. | ||
| 1. Performance improvements: Enhancements that noticeably speed up the application. | ||
| 1. Bug fixes: Corrections to issues that users have encountered or reported. |
There was a problem hiding this comment.
Suggested change
| 1. Bug fixes: Corrections to issues that users have encountered or reported. | |
| 1. Bug fixes |
docs/project/contributing.md
Outdated
| 1. Backend optimizations: Improvements to server-side processes that don't noticeably affect performance. | ||
| 1. Database schema changes: Modifications to the data structure that don't alter the user interface. | ||
| 1. Development tooling updates: Changes to build processes or development environments. | ||
| 1. Internal API modifications: Alterations to internal APIs that don't affect the public-facing functionality. |
There was a problem hiding this comment.
Suggested change
| 1. Internal API modifications: Alterations to internal APIs that don't affect the public-facing functionality. | |
| 1. Internal API: Adding/Altering APIs tagged as internal |
docs/project/contributing.md
Outdated
|
|
||
| ### User-Facing Changes Examples | ||
| 1. UI/UX modifications: Changes to the layout, color scheme, or navigation structure. | ||
| 1. New features: Adding functionality that users can directly interact with. |
There was a problem hiding this comment.
Unless defined as internal. What about experimental features?
There was a problem hiding this comment.
@N-o-Z mm good point! what do you think, a little bit controversial
There was a problem hiding this comment.
- IMHO experimental changes are "user-visible", just marked "experimental". This gives users a chance to let us know if they want them or not.
docs/project/contributing.md
Outdated
| 1. Development tooling updates: Changes to build processes or development environments. | ||
| 1. Internal API modifications: Alterations to internal APIs that don't affect the public-facing functionality. | ||
| 1. Documentation updates: Changes to the project's documentation that don't impact the user experience. | ||
| 1. Imported libraries: Updates to third-party libraries that don't introduce new features, bug fixes, performance improvements or security updates. |
There was a problem hiding this comment.
I don't think we need to add to the changelog third party updates at all regardless of security or otherwise. If it fixes a bug in lakeFS or adds performance it go into one of the former categories.
arielshaqed
approved these changes
Nov 24, 2024
docs/project/contributing.md
Outdated
|
|
||
| ### User-Facing Changes Examples | ||
| 1. UI/UX modifications: Changes to the layout, color scheme, or navigation structure. | ||
| 1. New features: Adding functionality that users can directly interact with. |
There was a problem hiding this comment.
- IMHO experimental changes are "user-visible", just marked "experimental". This gives users a chance to let us know if they want them or not.
docs/project/contributing.md
Outdated
| ### Non-User-Facing Changes: | ||
| 1. Code refactoring: Restructuring the codebase without changing its external behavior. | ||
| 1. Backend optimizations: Improvements to server-side processes that don't noticeably affect performance. | ||
| 1. Database schema changes: Modifications to the data structure that don't alter the user interface. |
There was a problem hiding this comment.
Suggested change
| 1. Database schema changes: Modifications to the data structure that don't alter the user interface. | |
| 1. Database schema changes: Modifications to the data structure that don't alter the user interface **and** do not require data migration. |
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.
No description provided.