From 37137ad3a7a003233caea1e4b288c08c53ba2e9a Mon Sep 17 00:00:00 2001 From: Harsha Vamsi Kalluri Date: Wed, 19 Oct 2022 10:31:58 -0700 Subject: [PATCH] Update literature around changelog (#242) * Update literature Signed-off-by: Harsha Vamsi Kalluri * Removing pr template and updating language Signed-off-by: Harsha Vamsi Kalluri Signed-off-by: Harsha Vamsi Kalluri Co-authored-by: Daniel (dB.) Doubrovkine --- .github/pull_request_template.md | 17 ----------------- CHANGELOG.md | 1 + CONTRIBUTING.md | 14 +++++++------- 3 files changed, 8 insertions(+), 24 deletions(-) delete mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index fe308410bc..0000000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,17 +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 - - [ ] New functionality is added to `docs` folder -- [ ] Commits are signed per the DCO using --signoff -- [ ] Commit changes are listed out in CHANGELOG.md file (See: [Changelog](https://github.com/opensearch-project/opensearch-java/blob/main/CONTRIBUTING.md#changelog)) - -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-java/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index b7ddacf1e0..b8de976157 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Github workflow for dependabot PRs ([#247](https://github.com/opensearch-project/opensearch-java/pull/247)) ### Changed +- Update literature around changelog contributions in CONTRIBUTING.md ([#242](https://github.com/opensearch-project/opensearch-java/pull/242)) - Update tests to use JUnit's Assert ([#244]https://github.com/opensearch-project/opensearch-java/pull/244) ### Deprecated diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9be415c088..36bc8c0711 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) - - [How to add my changes to CHANGELOG?](#how-to-add-my-changes-to-changelog) + - [Adding Changes](#adding-changes) - [Review Process](#review-process) ## Contributing to OpenSearch @@ -84,17 +84,17 @@ You may type this line on your own when writing your commit messages. However, i ## Changelog -OpenSearch-Java maintains 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. -Briefly, the changes are curated by version, with the changes to the main branch added chronologically to `Unreleased` version. Further, each version has corresponding sections which list out the category of the change - `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`. +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`. -### How to add my changes to [CHANGELOG](CHANGELOG.md)? +### Adding Changes -As a contributor, you must ensure that every pull request has the changes listed out within the corresponding version and appropriate section of [CHANGELOG](CHANGELOG.md) file. +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. -Adding in the change is two step process - -1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR +Adding in the change is a two step process - +1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR. 2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.