From c674849dab6ee33aefd622782a3be1cc80fc7959 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Tue, 9 Jun 2026 10:06:36 +0200 Subject: [PATCH 1/4] configure categories for github auto-generated release notes --- .github/release.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/release.yml diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 000000000..f9d6e921c --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,22 @@ +# Configuration for auto-generated release notes +# https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes + +changelog: + categories: + - title: Breaking changes + labels: + - breaking-change + - title: New features + labels: + - feature + - title: Bugfixes and other changes + labels: + - '*' + exclude: + labels: + - breaking-change + - feature + - dependencies + - title: Dependency upgrades + labels: + - dependencies From 9adcaefe23c1f6a4bb9f85fbb52e8a70f678e689 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Tue, 9 Jun 2026 10:53:58 +0200 Subject: [PATCH 2/4] add configuration and deprecation categories to release.yml --- .github/release.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/release.yml b/.github/release.yml index f9d6e921c..3664b052f 100644 --- a/.github/release.yml +++ b/.github/release.yml @@ -6,6 +6,12 @@ changelog: - title: Breaking changes labels: - breaking-change + - title: Configuration changes + labels: + - configuration + - title: Deprecations + labels: + - deprecation - title: New features labels: - feature @@ -15,6 +21,8 @@ changelog: exclude: labels: - breaking-change + - configuration + - deprecation - feature - dependencies - title: Dependency upgrades From df7281946e1841a406f7e0deecbc2ac10418eaa4 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Tue, 9 Jun 2026 11:14:21 +0200 Subject: [PATCH 3/4] mention PR labels in contributing file and highlight the importance of PR titles and labels --- CONTRIBUTING.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fceec6b6..fd2d549d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,16 +30,23 @@ Note that there is still a `develop` branch, but that is legacy. All significant contributions should be added via [pull requests] (PRs). This allows us to discuss and review the changes, and document design choices. -Very minor changes, like fixing a typo in the readme or a comment, can sometimes be pushed directly onto master. +It also ensures that the contribution is mentioned in the auto-generated change logs. -Pull request titles must be *concise* and *descriptive*. -This enables auto-generation of meaningful change logs during the release process. +A significant change is anything that is worth knowing about for developers or end users. +Tiny changes that do not directly affect the inner workings of the application, like fixing some typos in the readme or a comment, can sometimes be pushed directly onto the `master` branch. +Always ask yourself: Should this change appear in the change log? + +## Pull request titles and labels are important + +Pull requests form the basis for the change logs that are auto-generated during the release process. +For this reason, PR titles must be *concise* and *descriptive*. +When writing a PR title, remember that this title is the only thing users will see in the change log. +Also note that change log entries are categorised based on their *labels*, as defined in [release.yml]. ## Pull requests must be focused Individual PRs *must* have a strong focus which is clear from the title. -When writing the title, remember that it is the only thing users will see in the change log. -PRs should also have a clear description and rationale, and should be linked to relevant issues, if any. +PRs should also have a clear description and rationale and should be linked to relevant issues, if any. If a PR gets very large, split it up into smaller PRs that can be reviewed separately. @@ -50,9 +57,9 @@ We prefer a squash merge for small PRs, resulting in a single commit. However, in some cases, it may be useful to keep the individual commits from the PR. In that case we use a merge commit (as in `--no-ff`). -## External dependencies are minimized +## External dependencies are minimised -To reduce the maintenance burden, we aim to minimize the number of external dependencies. +To reduce the maintenance burden, we aim to minimise the number of external dependencies. If external dependencies cannot be avoided, we prefer well-supported projects with large numbers of contributors. ## Semantic versioning applies to the API @@ -68,5 +75,6 @@ For example, breaking changes in application *configuration* may occur in `minor [merge methods]: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github [pull requests]: https://github.com/FAIRDataTeam/FAIRDataPoint-client-redux/pulls [releases]: https://github.com/FAIRDataTeam/FAIRDataPoint/releases +[release.yml]: .github/release.yml [semantic versioning]: https://semver.org [trunk-based development]: https://trunkbaseddevelopment.com/ From be968ed90767a5a50aadeb8278b900602dc83778 Mon Sep 17 00:00:00 2001 From: dennisvang <29799340+dennisvang@users.noreply.github.com> Date: Tue, 9 Jun 2026 11:26:46 +0200 Subject: [PATCH 4/4] fix link in contributing --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd2d549d5..fc42a64b6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,7 +73,7 @@ For example, breaking changes in application *configuration* may occur in `minor [github flow]: https://githubflow.github.io/ [issues]: https://github.com/FAIRDataTeam/FAIRDataPoint/issues [merge methods]: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github -[pull requests]: https://github.com/FAIRDataTeam/FAIRDataPoint-client-redux/pulls +[pull requests]: https://github.com/FAIRDataTeam/FAIRDataPoint/pulls [releases]: https://github.com/FAIRDataTeam/FAIRDataPoint/releases [release.yml]: .github/release.yml [semantic versioning]: https://semver.org