search

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

Moving the security/privacy concern section further down? #56

Closed iteles closed 7 years ago

iteles commented 7 years ago

Having this security/privacy concern section at the top means that there is no section of the step-by-step process which is the content of this repo that shows up 'above the fold' once you've scrolled down to the readme on a desktop:

dwyl-contributing-repo-nothing-above-the-fold

We might want to give people a glimpse of what they came here for quickly so they don't get distracted/start scrolling and just scroll past everything without reading it.

Thoughts welcome as this is just a personal impression!

nelsonic commented 7 years ago

@iteles I debated where to put the Security clause... I think pushing it down in the Readme de-emphasises it... But equally 99.9% of issues/contributions will not be security-related. so forcing people to read the paragraph when they don't have a Security-related question/issue, is probably just annoying people. right...?

iteles commented 7 years ago

That would be my view based on experience: if people see content that's not relevant to them, they'll immediately start skimming with a different mindset.

nelsonic commented 7 years ago

Agreed. moving it. 👍