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

Can Changelog link to the PR? #128

Open
rebeccafae opened this issue Jun 12, 2024 · 4 comments
Open

Can Changelog link to the PR? #128

rebeccafae opened this issue Jun 12, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@rebeccafae
Copy link

In the changelog, can it link to the PR that made the change? It would make it a lot easier to find some of these to better see the impact it is having.

@pirj
Copy link
Member

pirj commented Jun 13, 2024

I support the idea for all our repos @rubocop/rubocop-rspec WDYT?

@bquorning
Copy link
Contributor

I like the idea too. The main downside is that you don’t know the PR number when you write the changelog entry. It would be more efficient maybe to add the links right before releasing a new version?

@rebeccafae
Copy link
Author

rebeccafae commented Jun 13, 2024

I like the idea too. The main downside is that you don’t know the PR number when you write the changelog entry. It would be more efficient maybe to add the links right before releasing a new version?

You don't? Doesn't the line get added in the same PR as the change, like in this one? #99

I haven't contributed here so I don't know, just curious based on what I thought the process was.

@bquorning
Copy link
Contributor

bquorning commented Jun 13, 2024

Yes, the changelog lines get added in each PR. What I meant was that the contributor don’t know the number of the PR until it’s opened, which is after they push their code. So if we require the PR number to be in the changelog before we can merge a PR, each contributor has to push to their branch twice: Once before opening the PR and (at least) once after opening the PR.

What I’m saying is that I would very much like to still be able to make one-push pull requests.

Update: Just to be clear, I like the idea, and I often find myself navigating from the RuboCop changelog to a code search to find the PR where code was introduced. Your suggestion would make that so much easier. We just need to figure out how to do it efficiently, and not put an extra burden on contributors.

@ydah ydah added the enhancement New feature or request label Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants