|
6 | 6 | - [Contributing Code](#contributing-code)
|
7 | 7 | - [Developer Certificate of Origin](#developer-certificate-of-origin)
|
8 | 8 | - [Changelog](#changelog)
|
9 |
| - - [How to add my changes to CHANGELOG?](#how-to-add-my-changes-to-changelog) |
| 9 | + - [Adding Changes](#adding-changes) |
10 | 10 | - [Review Process](#review-process)
|
11 | 11 |
|
12 | 12 | ## Contributing to OpenSearch
|
@@ -84,17 +84,17 @@ You may type this line on your own when writing your commit messages. However, i
|
84 | 84 |
|
85 | 85 | ## Changelog
|
86 | 86 |
|
87 |
| -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. |
| 87 | +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. |
88 | 88 |
|
89 |
| -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`. |
| 89 | +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`. |
90 | 90 |
|
91 | 91 |
|
92 |
| -### How to add my changes to [CHANGELOG](CHANGELOG.md)? |
| 92 | +### Adding Changes |
93 | 93 |
|
94 |
| -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. |
| 94 | +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. |
95 | 95 |
|
96 |
| -Adding in the change is two step process - |
97 |
| -1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR |
| 96 | +Adding in the change is a two step process - |
| 97 | +1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR. |
98 | 98 |
|
99 | 99 | 2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.
|
100 | 100 |
|
|
0 commit comments