dwyl / dwyl/contributing

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

Open
#105 0 comments 0 reactions 0 assignees View on GitHub
discuss help wanted question
Dominant language
No language data
Stars
91
Forks
9
PR merge metrics
No merged PRs in 30d

Description

### 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 `readme`s. 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?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.