Update article: Pull Requests

DXHeroes / knowledge-base-content

Open-source knowledge base covering topics about developer experience.

https://developerexperience.io

Other

134 stars 70 forks source link

Update article: Pull Requests #266

Closed ridlees closed 4 years ago

ridlees commented 4 years ago

[x] Link to practice: "https://developerexperience.io/practices/pull-requests"
[x] What is this about: I would like to enrich the "anatomy" of a pull request from the current version: Encourage small pull requests. Nobody wants to review 5000+ lines of changes within one PR. according to this article (https://medium.com/@hugooodias/the-anatomy-of-a-perfect-pull-request-567382bb6067)

How to contribute:

Follow our Contribution guide
How to Git and Pull Requests
How to Markdown, Markdown interactive demo or Google Docs Addon

snehal199 commented 4 years ago

can I pick this up @ridlees ?

ridlees commented 4 years ago

@snehal199 Sure, go for it!

snehal199 commented 4 years ago

@ridlees I plan to change the point to- "Encourage pull requests that are short and solve a specific problem. Also inculcate the practice of giving pull requests a relevant and precise title and description. These practices make the process of code review and product development faster,easier and more efficient."

Would that be good or should I make some changes?

ShyamPraveenSingh commented 4 years ago

Can anyone explain to me what is this issue about? I would to work on it.

ridlees commented 4 years ago

@snehal199 Thanks for the question. I would suggest expanding the part about the anatomy of a great pull request. In the article I have linked, you have some specific details (like that pull request should be smaller than 250 lines of code). I would also recommend adding the article into sources for the Pull request article. Similarly, you could explore the relevant title and description part. There is an example pull request in the medium post. You can find info about character limit or samples inn sources like https://github.blog/2015-01-21-how-to-write-the-perfect-pull-request/ or https://www.atlassian.com/blog/git/written-unwritten-guide-pull-requests.

ridlees commented 4 years ago

@ShyamPraveenSingh Hello, this issue is about updating an existing article in our Knowledge Base with the anatomy of a good pull request. @snehal199 is currently working on this. You can look at other curated issues if you want to contribute.

DominikMilaniak commented 4 years ago

Hi again @snehal199! 🙂

A few days have passed since our last contact, how is it going so far with the article? Is anything not clear enough or do you need help with something? I am in no way pushing you, you can take as much time as you need 🙂 Just wanted to get in touch to make sure everything is ok 👍

If you are no longer interested in writing this article - which is completely fine 🙂 I will happily assign this article to someone else, possibly @ShyamPraveenSingh, if he's still interested in creating it 🙂

ShyamPraveenSingh commented 4 years ago

Yes Sir @DominikMilaniak very much interested! 😃

snehal199 commented 4 years ago

Sorry for the delay @DominikMilaniak :sweat_smile: , I would be making a pr for the issue soon.

DominikMilaniak commented 4 years ago

No problem @snehal199, take as much time as you need! 😄 Looking forward to your PR!

@ShyamPraveenSingh - Did you find any other topic from our Issues list you would be interested in? I will happily assign you to any other article you would find interesting to work on. 2 people working on the same one would be kinda counter-productive 😅

ShyamPraveenSingh commented 4 years ago

Yes I totally understand. Let me browse through the issues list and I'll let you know about it.