AbsaOSS / AbsaOSS/generate-release-notes

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

Open
#40 4 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
13
Forks
0
Avg merge
6h 50m
Merged PRs (30d)
7

Description

## 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

...

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.