Skip to content

Commit 4e0877a

Browse files
committed
Add documentation
Signed-off-by: Owais <owaiskazi19@gmail.com>
1 parent c95f53e commit 4e0877a

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
1919

2020

2121
### Enhancements
22-
- Github workflow for changelog verification ([#1413](https://github.com/opensearch-project/anomaly-detection/pull/1412))
22+
- Github workflow for changelog verification ([#1413](https://github.com/opensearch-project/anomaly-detection/pull/1413))
2323
### Bug Fixes
2424

2525
### Infrastructure

DEVELOPER_GUIDE.md

+24
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- [Backports](#backports)
1212
- [Gradle Plugins](#gradle-plugins)
1313
- [Distribution Download Plugin](#distribution-download-plugin)
14+
- [Changelog](#changelog)
1415

1516
## Developer Guide
1617

@@ -102,3 +103,26 @@ The Distribution Download plugin downloads the latest version of OpenSearch by d
102103
```
103104
./gradlew integTest -PcustomDistributionUrl="https://ci.opensearch.org/ci/dbc/bundle-build/1.2.0/1127/linux/x64/dist/opensearch-1.2.0-linux-x64.tar.gz"
104105
```
106+
107+
## Changelog
108+
109+
AD 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.1.0/) format.
110+
111+
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`.
112+
113+
#### How to add my changes to [CHANGELOG](CHANGELOG.md)?
114+
115+
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.
116+
117+
Adding in the change is two step process -
118+
1. Add your changes to the corresponding section within the CHANGELOG file with dummy pull request information, publish the PR
119+
120+
`Your change here ([#PR_NUMBER](PR_URL))`
121+
122+
2. Update the entry for your change in [`CHANGELOG.md`](CHANGELOG.md) and make sure that you reference the pull request there.
123+
124+
[Example PR](https://github.com/opensearch-project/flow-framework/pull/998/files#diff-06572a96a58dc510037d5efa622f9bec8519bc1beab13c9f251e97e657a9d4edR24)
125+
126+
For future release notes, all entries can be directly copied to the release notes and then deleted from either the 2.x or 3.0 section as a cleanup. For example, see: https://github.com/opensearch-project/flow-framework/pull/1036/files
127+
128+
For changes that don't require an entry, we can add the 'skip-changelog' label to the PR. This will allow the changelog workflow to pass without adding an entry."

0 commit comments

Comments
 (0)