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 摘要。