Update literature around changelog (opensearch-project#242)

* Update literature Signed-off-by: Harsha Vamsi Kalluri <[email protected]> * Removing pr template and updating language Signed-off-by: Harsha Vamsi Kalluri <[email protected]> Signed-off-by: Harsha Vamsi Kalluri <[email protected]> Co-authored-by: Daniel (dB.) Doubrovkine <[email protected]>
abhinav-nath · Oct 21, 2022 · 37137ad · 37137ad
1 parent 732801a
commit 37137ad
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 24 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
diff --git 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
@@ -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.