add changelog & PR template #36
Closed
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
bhgomes
suggested changes
Jul 1, 2022
| - [ ] Updated relevant documentation in the code. | ||
| - [ ] Re-reviewed `Files changed` in the Github PR explorer. | ||
| - [ ] Update the version numbers properly: | ||
| * ./Cargo.toml |
There was a problem hiding this comment.
This is a deprecated file. It should not be changed.
Comment on lines
+1
to
+17
| # Changelog | ||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [x.y.z] - yyyy-mm-dd | ||
| ### Added | ||
|
|
||
| ### Changed | ||
|
|
||
| ### Deprecated | ||
|
|
||
| ### Removed | ||
|
|
||
| ### Fixed | ||
|
|
||
| ### Security |
There was a problem hiding this comment.
See the changelog in manta-rs for the format (like Unreleased instead of x.y.z) and also the correct linking setup. Also, for the first CHANGELOG.md add at least the previous version changes instead of just nothing.
| write a little note why. | ||
|
|
||
| - [ ] Linked to Github issue with discussion and accepted design OR have an explanation in the PR that describes this work. | ||
| - [ ] Test changes against the associated `manta-front-end` PR |
There was a problem hiding this comment.
Can we add more documentation on what this means?
|
Closed in favor of #84. |
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.