dwyl / contributing

:clipboard: Guidelines & Workflow for people contributing to our project(s) on GitHub. Please :star: to confirm you've read & understood! :white_check_mark:
88 stars 9 forks source link

Describe Pull Request Review Process #63

Closed nelsonic closed 7 years ago

nelsonic commented 7 years ago

"We'll finish what we started..." https://youtu.be/hgKDu5pp_fU

nelsonic commented 7 years ago

@iteles i've attempted to add the PR review process instructions and tidied up a bit. please review when you can so we can get this updated. thanks. p.s. I haven't touched the "Labels" section beyond linking to #40 Please assign to me if you are low on time and I will PR the change. Thanks! 👍

iteles commented 7 years ago

This is crazy impressive, so much time has gone into making this flow! 👏

My only note is that it is still very lengthy which is the reason people have told us the process is hard to internalise/follow/remember in the past. I feel that there is still the need for a shortened version that people can still use as reference (hence #12 and #28) once they have read through this process. But there are issues open on this.

nelsonic commented 7 years ago

While I agree that the doc is lengthy, I have made the effort to break it down in to a "3 Part" Process with a simple-ish diagram. I'd be delighted if someone can simplify it further.

Ultimately I can give requirements for what the doc needs to contain and what sections it needs to have. but I'm not good with engrish so would be stoked if someone else would do the writing...! 👍

nelsonic commented 7 years ago

@iteles I have made all the changes you have suggested (so far in your PR review). I'm happy to keep making changes until we are "content" with the content. But equally would be stoked if someone else made those changes/improvements. This is really meant to be a collaborative effort where everyone in the Org helps to evolve the "contributing guide/process" over time... #HelpWanted More review comments gladly welcomed. ❤️ ✅ 🚀

iteles commented 7 years ago

:+1: Merging this so people can start reviewing as a whole which I think will be more useful.