Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #2808
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
…cklist. Signed-off-by: dblock <dblock@amazon.com>
dblock
requested review from
ps48,
kavithacm,
derek-ho,
joshuali925,
dai-chen,
YANG-DB,
rupal-bq,
mengweieric,
vamsi-amazon,
Swiddis,
penghuo,
seankao-az,
MaxKsyunz,
Yury-Fridlyand,
anirudha,
forestmvey,
acarbonetto,
GumpacG and
ykmr1224
as code owners
22 tasks
derek-ho
previously approved these changes
Jul 9, 2024
noCharger
approved these changes
Jul 10, 2024
LantaoJin
reviewed
Jul 12, 2024
| - [ ] New functionality has been documented. | ||
| - [ ] New functionality has javadoc added | ||
| - [ ] New functionality has user manual doc added |
There was a problem hiding this comment.
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.
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>
dai-chen
approved these changes
Jul 29, 2024
derek-ho
approved these changes
Jul 29, 2024
manasvinibs
pushed a commit
to manasvinibs/sql
that referenced
this pull request
Aug 14, 2024
…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>
jzonthemtn
pushed a commit
to jzonthemtn/sql
that referenced
this pull request
Aug 28, 2024
…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>
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.
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.