-
Notifications
You must be signed in to change notification settings - Fork 49
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add changelog and changelog verifier #111
Add changelog and changelog verifier #111
Conversation
73546ff
to
fc1213f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks really good. Just some pretty minor grammar and phrasing suggestions from me
Good catch @Xtansia. I have more in opensearch-project/opensearch-go#172. |
fc1213f
to
ccdb9b1
Compare
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
ccdb9b1
to
6c194f0
Compare
Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
@Xtansia you good with this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just one comment, happy for it to be merged regardless though
## Overview | ||
|
||
This document explains who the maintainers are (see below), what they do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). | ||
[This document](https://github.com/opensearch-project/.github/blob/main/MAINTAINERS.md#maintainer-responsibilities) explains who the maintainers are (see below), what they do in this repo, and how they should be doing it. If you're interested in contributing, see [CONTRIBUTING](CONTRIBUTING.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Saying "This document" linking to another document, while explaining the contents of the current document and the linked one is somewhat confusing. I think it'd be better to rephrase this to something like This document lists the current maintainers of this repository. An explanation of what they do and their responsibilities can be found in the [central opensearch project MAINTAINERS file]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I hit merge - this is a valid comment though, we have this language all over the place. Something to add to a template ...
Signed-off-by: Harsha Vamsi Kalluri [email protected]
Description
Introduces changelog and changelog verifier.
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.