Skip to content

Commit 832fe42

Browse files
harshavamsidblock
andauthored
Update literature around changelog (#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]>
1 parent 3068b76 commit 832fe42

File tree

3 files changed

+8
-24
lines changed

3 files changed

+8
-24
lines changed

.github/pull_request_template.md

-17
This file was deleted.

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
77
- Github workflow for dependabot PRs ([#247](https://github.com/opensearch-project/opensearch-java/pull/247))
88

99
### Changed
10+
- Update literature around changelog contributions in CONTRIBUTING.md ([#242](https://github.com/opensearch-project/opensearch-java/pull/242))
1011
- Update tests to use JUnit's Assert ([#244]https://github.com/opensearch-project/opensearch-java/pull/244)
1112

1213
### Deprecated

CONTRIBUTING.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
- [Contributing Code](#contributing-code)
77
- [Developer Certificate of Origin](#developer-certificate-of-origin)
88
- [Changelog](#changelog)
9-
- [How to add my changes to CHANGELOG?](#how-to-add-my-changes-to-changelog)
9+
- [Adding Changes](#adding-changes)
1010
- [Review Process](#review-process)
1111

1212
## Contributing to OpenSearch
@@ -84,17 +84,17 @@ You may type this line on your own when writing your commit messages. However, i
8484

8585
## Changelog
8686

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.
8888

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`.
9090

9191

92-
### How to add my changes to [CHANGELOG](CHANGELOG.md)?
92+
### Adding Changes
9393

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.
9595

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.
9898

9999
2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.
100100

0 commit comments

Comments
 (0)