Skip to content

Commit 6351af5

Browse files
author
Ish Shah
authored
Add changelog info to docs and contribution guide (operator-framework#5093)
* Add changelog info to docs and contribution guide Signed-off-by: Ish Shah <[email protected]> * Address comments Signed-off-by: Ish Shah <[email protected]>
1 parent 82e8ebb commit 6351af5

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

CONTRIBUTING.MD

+6-1
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,13 @@ The first line is the subject and should be no longer than 70 characters, the se
6464

6565
Most contributions involve some sort of documentation. See our [doc contribution guidelines][doc-contrib] for details.
6666

67+
## Changelog
68+
69+
The operator-sdk maintains a changelog and most contributions should involve a changelog entry. See our [changelog contribution guidelines][changelog-contrib] for details.
70+
6771
[operator_framework]: https://groups.google.com/forum/#!forum/operator-framework
6872
[developer-guide]: https://sdk.operatorframework.io/docs/contribution-guidelines/developer-guide/
6973
[reporting-issues]: https://sdk.operatorframework.io/docs/contribution-guidelines/reporting-issues/
7074
[golang-style-doc]: https://github.com/golang/go/wiki/CodeReviewComments
71-
[doc-contrib]:https://sdk.operatorframework.io/docs/contribution-guidelines/documentation
75+
[doc-contrib]: https://sdk.operatorframework.io/docs/contribution-guidelines/documentation
76+
[changelog-contrib]:https://master.sdk.operatorframework.io/docs/contribution-guidelines/changelog
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Changelog
3+
weight: 25
4+
---
5+
6+
The Operator SDK project tracks changes across releases by maintaining a live changelog. This changelog is compiled via fragments located in `changelog/fragments`
7+
8+
Contributors are asked to add these changelog fragments when creating pull requests by following this [template][changelog-template].
9+
10+
The changlog fragments document the following information:
11+
12+
* Description of Changes
13+
* Types of Changes
14+
* One of: addition, change, deprecation, removal, bugfix
15+
* Migration Guide for Changes
16+
* These are required for breaking changes, and essential (but not required) for scaffolding-related changes.
17+
18+
[changelog-template]: https://github.com/operator-framework/operator-sdk/blob/master/changelog/fragments/00-template.yaml

0 commit comments

Comments
 (0)