Skip to content
This repository was archived by the owner on Mar 22, 2023. It is now read-only.

Commit f7acc37

Browse files
Merge pull request #1042 from lukaszstolarczuk/add-changelog-template
Extend contributing.md to encourage putting major changes to ChangeLog
2 parents 21576bf + f180f76 commit f7acc37

3 files changed

Lines changed: 17 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ make cppformat
3737

3838
We take outside code contributions to `libpmemobj-cpp` through GitHub pull requests.
3939

40+
If you add a new feature or fix a critical bug please append appropriate entry
41+
to ChangeLog under newest release.
42+
4043
**NOTE: If you do decide to implement code changes and contribute them,
4144
please make sure you agree your contribution can be made available under the
4245
[BSD-style License used for libpmemobj-cpp](LICENSE).**

ChangeLog

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
XXX Igor Chorążewicz <igor.chorazewicz@intel.com>
2+
3+
* Version 1.13
4+
5+
New features:
6+
-
7+
8+
Bug fixes:
9+
-
10+
11+
Other changes:
12+
-
13+
114
Mon Feb 15 2021 Igor Chorążewicz <igor.chorazewicz@intel.com>
215

316
* Version 1.12

doc/RELEASE_STEPS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This document contains all the steps required to make a new release of libpmemob
77
Make a release locally:
88
- add an entry to ChangeLog, remember to change the day of the week in the release date
99
- for major/minor releases mention compatibility with the previous release
10+
- for major/minor releases add new ChangeLog template (for $VER+1)
1011
- echo $VERSION > .version
1112
- git add .version
1213
- update project's version in top-level CMakeLists.txt

0 commit comments

Comments
 (0)