-
Notifications
You must be signed in to change notification settings - Fork 75
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. #1262
Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #1262
Conversation
…cklist. Signed-off-by: dblock <dblock@amazon.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1262 +/- ##
============================================
+ Coverage 71.83% 77.08% +5.25%
- Complexity 4898 5290 +392
============================================
Files 518 517 -1
Lines 22879 22890 +11
Branches 2245 2239 -6
============================================
+ Hits 16434 17645 +1211
+ Misses 5410 4212 -1198
+ Partials 1035 1033 -2
Flags with carried forward coverage won't be shown. Click here to find out more. |
### Check List | ||
- [ ] New functionality includes testing. | ||
- [ ] New functionality has been documented. | ||
- [ ] API changes companion pull request [created](https://github.com/opensearch-project/opensearch-api-specification/blob/main/DEVELOPER_GUIDE.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.
To me its not coming out clear from messaging side. Should we say something like
- New/Modify Existing APIs. API changes companion pull request created.
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 propose to keep it consistent with other repos (x20 PRs), this is the language that was chosen in core.
@owaiskazi19 can we merge? |
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.