Web-Dev-For-Beginners icon indicating copy to clipboard operation
Web-Dev-For-Beginners copied to clipboard

Published 20 hours ago • verified publisher icon microsoft

Update CONTRIBUTING.md for PR clarity

Open SmashedFrenzy16 opened this issue 2 years ago • 5 comments

Adding the fact that you should try to specify why you made a certain change when creating a pull request. This change was made at the end of the second paragraph of CONTRIBUTING.md to add this instruction.

SmashedFrenzy16 avatar Jul 27 '22 12:07 SmashedFrenzy16

I'm not sure I'm following the reasoning for this change. When a pull request is created, it already has the ability to show what the changes are and where they are. What would the benefit be of asking someone to repeat the same information in the description?

alfredodeza avatar Jul 27 '22 13:07 alfredodeza

Some do not specify where the change occured and what change they made for what reason when they submit a PR. It is easier just to check on the main PR page.

SmashedFrenzy16 avatar Jul 27 '22 14:07 SmashedFrenzy16

@SmashedFrenzy16 I think there's value in adding the "Why" but I agree with Alfredo on the where. Could you please modify it to only speak on the why and we can approve it?

softchris avatar Aug 04 '22 11:08 softchris

I will change it as soon as possible @softchris.

SmashedFrenzy16 avatar Aug 04 '22 13:08 SmashedFrenzy16

@softchris I have changed the file and my original comment to only include the "Why" part.

SmashedFrenzy16 avatar Aug 04 '22 14:08 SmashedFrenzy16