-
Notifications
You must be signed in to change notification settings - Fork 133
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
Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #2808
Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #2808
Conversation
…cklist. Signed-off-by: dblock <dblock@amazon.com>
- [ ] New functionality has been documented. | ||
- [ ] New functionality has javadoc added | ||
- [ ] New functionality has user manual doc added |
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.
Could we keep these two sub-checkboxes? Or merge into one line such as
[ ] New functionality has been documented(javadoc, [user manual doc](https://github.com/opensearch-project/sql/blob/main/DEVELOPER_GUIDE.rst#reference-manual).
or
[ ] New functionality has been documented(javadoc, [user manual doc](https://github.com/opensearch-project/sql/tree/main/docs/user).
They are the actual items to explain what is New functionality has been documented
meaning. It should be helpful to any new contributor.
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 re-added those as they were before. The links will vary per branch, it's a different can of worms, leaving it to ya'll for a later improvement.
Signed-off-by: dblock <dblock@amazon.com>
…cklist. (opensearch-project#2808) * Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. Signed-off-by: dblock <dblock@amazon.com> * Re-added sections. Signed-off-by: dblock <dblock@amazon.com> --------- Signed-off-by: dblock <dblock@amazon.com>
…cklist. (opensearch-project#2808) * Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. Signed-off-by: dblock <dblock@amazon.com> * Re-added sections. Signed-off-by: dblock <dblock@amazon.com> --------- Signed-off-by: dblock <dblock@amazon.com>
Coming from opensearch-project/opensearch-api-specification#387, update PR template to include a checkbox that requests that all API changes be documented in the OpenAPI spec used to generate clients.