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:
86 stars 9 forks source link

Adding reasons *why* anecdotes to the processes and contributing.md for extra motivation? #105

Open iteles opened 5 years ago

iteles commented 5 years ago

Preamble

@nelsonic and I were talking yesterday about what could be improved in the school system and how when we were kids no one would ever explain why we were learning what we were taught other than that we were expected to know these things. This meant we didn't understand why we had to learn those things and our motivation crashed.

Adding why throughout

We do things differently at dwyl. We care about more than just excellent code. We care about metrics, simplicity, reusability, maintainability, we care about dwylers and we care about about our clients.

Being specific about how we do things and about sharing our knowledge with others means that we end up with some necessarily lengthy readmes. https://github.com/dwyl/start-here/issues/118

Would it be worth adding anecdotes from our project experience throughout the process readmes in order to help people understand why they are each important as well as having one overarching 'Why?' section?

Would this increase motivation to keep going through the text and more importantly create connections in people's minds that would help them to remember to do things or would it actually just make the readmes longer and therefore have the opposite effect?