Added CHANGELOG and verifier workflow (#218)

* Added CHANGELOG and verifier workflow Signed-off-by: Harsha Vamsi Kalluri <[email protected]> * Update contributing to include changelog Signed-off-by: Harsha Vamsi Kalluri <[email protected]> * Fix links Signed-off-by: Harsha Vamsi Kalluri <[email protected]> * Add changelog and changelog verifier Signed-off-by: Harsha Vamsi Kalluri <[email protected]> * Adding dependabot actions for changelog PR Signed-off-by: Harsha Vamsi Kalluri <[email protected]> Signed-off-by: Harsha Vamsi Kalluri <[email protected]>
2022-10-20 11:48:53 -07:00
parent 006dfc6cd7
commit ecd15d44c7
5 changed files with 96 additions and 0 deletions
@@ -5,6 +5,8 @@
  - [Feature Requests](#feature-requests)
  - [Contributing Code](#contributing-code)
 - [Developer Certificate of Origin](#developer-certificate-of-origin)
+- [Changelog](#changelog)
+  - [Adding Changes](#adding-changes)
 - [Review Process](#review-process)

 ## Contributing to OpenSearch
@@ -80,6 +82,23 @@ Signed-off-by: Jane Smith <[email protected]>

 You may type this line on your own when writing your commit messages. However, if your user.name and user.email are set in your git configs, you can use `-s` or `– – signoff` to add the `Signed-off-by` line to the end of the commit message.

+## Changelog
+
+OpenSearch-py 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
+
+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 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.
+
+
 ## Review Process

 We deeply appreciate everyone who takes the time to make a contribution. We will review all contributions as quickly as possible. As a reminder, [opening an issue](https://github.com/opensearch-project/opensearch-py/issues/new/choose) discussing your change before you make it is the best way to smooth the PR process. This will prevent a rejection because someone else is already working on the problem, or because the solution is incompatible with the architectural direction.