diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index f8b8a2d143..0000000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,16 +0,0 @@ -### Description -[Describe what this change achieves] - -### Issues Resolved -[List any issues this PR will resolve] - -### Check List -- [ ] New functionality includes testing. - - [ ] All tests pass. -- [ ] New functionality has been documented. - - [ ] New functionality has comments added. -- [ ] Commits are signed per the DCO using --signoff. -- [ ] [CHANGELOG](https://github.com/opensearch-project/opensearch-java/blob/main/CONTRIBUTING.md#changelog) has been updated. - -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 the Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/opensearch-java/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f7b12c319..3850449a04 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ - [Contributing Code](#contributing-code) - [Developer Certificate of Origin](#developer-certificate-of-origin) - [Changelog](#changelog) - - [Adding changes](#adding-changes) + - [Adding Changes](#adding-changes) - [Review Process](#review-process) ## Contributing to OpenSearch @@ -84,12 +84,12 @@ You may type this line on your own when writing your commit messages. However, i ## Changelog -OpenSearch-Java maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. +OpenSearch-java maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. The changes are curated by version, with the changes to the main branch added chronologically to the `Unreleased` version. Each version has corresponding sections which list out the category of the change - `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`. -### Adding changes +### Adding Changes As a contributor, you must ensure that every pull request has its changes listed out within the corresponding version and appropriate section of the [CHANGELOG](CHANGELOG.md) file.