search

eclipse-platform / .github

Common contribution content for eclipse-platform repositories
https://www.eclipse.org/eclipse/
4 stars 10 forks source link

Add checklist for a valid PR #212

Closed fedejeanne closed 4 weeks ago

fedejeanne commented 4 weeks ago

What it does

Add some bullet points to illustrate how a valid PR should look like.

Goal

To have a link that can be shared so that: a. Contributors know how to properly prepare a PR and aid the reviewer in the reviewing process, letting him/her focus on the important part of the review i.e validating and testing the code. b. Committers have a checklist to go through before they merge a PR

Comments are welcome

I created the initial list based on my own experience. Any comments, additions, improvement proposals and so forth are highly appreciated!

I would like to have at least 2 or 3 thumbs ups 👍 or approvals ✔️ before merging this PR.

merks commented 4 weeks ago

You have my 👍 for whatever you personally think is the best final result. Thanks for making such a nice improvement.

fedejeanne commented 4 weeks ago

You have my 👍 for whatever you personally think is the best final result. Thanks for making such a nice improvement.

Thank you @merks !

jonahgraham commented 4 weeks ago

You have my 👍 for whatever you personally think is the best final result. Thanks for making such a nice improvement.

You have my 👍 too. Thanks @fedejeanne

fedejeanne commented 4 weeks ago

You have my 👍 for whatever you personally think is the best final result. Thanks for making such a nice improvement.

You have my 👍 too. Thanks @fedejeanne

Thank you @jonahgraham . Please notice that I removed the mention of the e-mail list you proposed before (see https://github.com/eclipse-platform/.github/pull/212#discussion_r1634643065). Please let me know if you disagree with the change, otherwise I will proceed with the merge today.

@laeubi thank you for your input, I hope the current version is fine for you?

jonahgraham commented 4 weeks ago

Thank you @jonahgraham . Please notice that I removed the mention of the e-mail list you proposed before (see #212 (comment)). Please let me know if you disagree with the change, otherwise I will proceed with the merge today.

np. probably should update this too in that case: https://github.com/fedejeanne/.github/blob/docs/add_reviewer_bulletpoints/CONTRIBUTING.md#contact

fedejeanne commented 4 weeks ago

np. probably should update this too in that case: https://github.com/fedejeanne/.github/blob/docs/add_reviewer_bulletpoints/CONTRIBUTING.md#contact

See https://github.com/eclipse-platform/.github/pull/213