Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Authors field for release notes has too many false positives #1468

Open
alice-i-cecile opened this issue Jun 27, 2024 · 1 comment
Open

Authors field for release notes has too many false positives #1468

alice-i-cecile opened this issue Jun 27, 2024 · 1 comment
Labels
A-Release-Notes C-Automation Tools to make repetitive tasks easier C-Bug A problem with the code that runs the site E-Good-First-Issue Good for newcomers

Comments

@alice-i-cecile
Copy link
Member

alice-i-cecile commented Jun 27, 2024

@Alice maybe we should default to Authors being populated by the original PR creator, then have a second (not actually rendered) list of "potential authors", populated by commit authors

The problem here is that people who left tiny suggestions get credited by default. While people who submit fixes or do extensive design work should be credited, typo fixes don't count 😛

@alice-i-cecile alice-i-cecile added C-Bug A problem with the code that runs the site E-Good-First-Issue Good for newcomers A-Release-Notes C-Automation Tools to make repetitive tasks easier labels Jun 27, 2024
@doup
Copy link
Contributor

doup commented Jun 28, 2024

In case someone wants to tackle this, as mentioned in Discord:

first author should be the PR author, after that come the contributors… it's a matter of splitting this into two props in the generated TOML (change generate_metadata_block to accept these in two separate vecs). Then update the release_notes.md template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Release-Notes C-Automation Tools to make repetitive tasks easier C-Bug A problem with the code that runs the site E-Good-First-Issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants