Skip to content

Commit

Permalink
Make change log submitting fragmented
Browse files Browse the repository at this point in the history
to avoid merge conflicts on CHANGELOG.md that prevent automatic merging
  • Loading branch information
boholder committed Sep 17, 2023
1 parent 6528c0e commit d68d587
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 3 deletions.
10 changes: 10 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
## Pull Request Checklist

[//]: # (Use `~~ -[ ] ... ~~` markdown deletion syntax to cross out unrelated entries)

- [ ] A new fragment is added in `./doc/news` that describes what is new (refer to issue #174).
- [ ] The unit test suite passes at the latest commit of this PR branch.

## Describe what you have changed in this PR

[//]: # (See commit messages.)
4 changes: 1 addition & 3 deletions doc/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
Please read [this issue for guide for modifying this document](https://github.com/khanshoaib3/minecraft-access/pull/155)

Release v1.3.0 (2023-09)
---------------------------

Expand All @@ -16,7 +14,7 @@ Release v1.3.0 (2023-09)

### Refactoring, Documentation and Chores

* Rewrite big README into [manual structure](https://github.com/khanshoaib3/minecraft-access/blob/1.20/README.md) for better readability.
* Rewrite big README into [manual structure](https://github.com/khanshoaib3/minecraft-access/blob/1.20/README.md) for better readability. [#134](https://github.com/khanshoaib3/minecraft-access/issues/134)

Release v1.2.2 (2023-09-12)
---------------------------
Expand Down
9 changes: 9 additions & 0 deletions doc/news/CHANGE_FRAGMENT_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
### New Features

### Feature Changes

### Bug Fixes

### Dependencies Changes

### Refactoring, Documentation and Chores
11 changes: 11 additions & 0 deletions doc/news/change_log_fragment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### New Features

### Feature Changes

### Bug Fixes

### Dependencies Changes

### Refactoring, Documentation and Chores

* Now the change log should be added as a small independent markdown file (fragment) under `./doc/news`.

0 comments on commit d68d587

Please sign in to comment.