AbsaOSS / AbsaOSS/generate-release-notes

Release Notes: Ignore Issue Title if there are release notes written within a given ticket

未关闭
#40 4 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
Python
星标
13
派生
0
平均合并
6 小时 50 分钟
30 天内合并 PR
7

描述

## Background
Ignore Issue title if a given Issue has Release Notes in it. I find this to potentially improve the readability of our Releases - let's keep the information brief but detailed enough and tidy.

Or even better, make it configurable.

## Example
Imagine that you have tickets 111 and 112, as detailed below.

### Ticket 111 (author A1 worked on it)
Title: Implement Algorithm BFS for problem X

Release Notes
- BFS implemented for problem X
- Optimized the backend part Y by Z amount of % on average

### Ticket 112 (author A2 worked on it)
Title: Enhancing Monitoring of the service Q

(and this ticket would have no release notes)

----

Final Release Draft would look like this:

...

### New Features 🎉

- #111 by @ A1
- BFS implemented for problem X
- Optimized the backend part Y by Z amount of % on average

- #112 Enhancing Monitoring of the service Q by @ A2

...

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。