diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..65ebc752 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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.) \ No newline at end of file diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md index 7d259f69..9128bdfd 100644 --- a/doc/CHANGELOG.md +++ b/doc/CHANGELOG.md @@ -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) --------------------------- @@ -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) --------------------------- diff --git a/doc/news/CHANGE_FRAGMENT_TEMPLATE.md b/doc/news/CHANGE_FRAGMENT_TEMPLATE.md new file mode 100644 index 00000000..a7db63aa --- /dev/null +++ b/doc/news/CHANGE_FRAGMENT_TEMPLATE.md @@ -0,0 +1,9 @@ +### New Features + +### Feature Changes + +### Bug Fixes + +### Dependencies Changes + +### Refactoring, Documentation and Chores diff --git a/doc/news/change_log_fragment.md b/doc/news/change_log_fragment.md new file mode 100644 index 00000000..d639917f --- /dev/null +++ b/doc/news/change_log_fragment.md @@ -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`. \ No newline at end of file