Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #2808

Merged
merged 2 commits into from
Jul 29, 2024
Merged

Update PULL_REQUEST_TEMPLATE to include an API spec change in the checklist. #2808

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
634be65
Update PULL_REQUEST_TEMPLATE to include an API spec change in the che…
dblock Jul 8, 2024
8246e66
Re-added sections.
dblock Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
### Description
[Describe what this change achieves]

### Issues Resolved
[List any issues this PR will resolve]


### Related Issues
Resolves #[Issue number to be closed when this PR is merged]
<!-- List any other related issues here -->

### Check List
- [ ] New functionality includes testing.
- [ ] All tests pass, including unit test, integration test and doctest
- [ ] New functionality has been documented.
- [ ] New functionality has javadoc added
- [ ] New functionality has user manual doc added
Copy link
Member

@LantaoJin LantaoJin Jul 12, 2024 •
edited
Loading

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.

Copy link
Member Author

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.

- [ ] Commits are signed per the DCO using --signoff
- [ ] New functionality has javadoc added.
- [ ] New functionality has a user manual doc added.
- [ ] API changes companion pull request [created](https://github.com/opensearch-project/opensearch-api-specification/blob/main/DEVELOPER_GUIDE.md).
- [ ] Commits are signed per the DCO using `--signoff`.
- [ ] Public documentation issue/PR [created](https://github.com/opensearch-project/documentation-website/issues/new/choose).

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](https://github.com/opensearch-project/OpenSearch/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).
For more information on following Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/sql/blob/main/CONTRIBUTING.md#developer-certificate-of-origin).
Loading