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

Wiki vs Readme/Docs in Repo #25

Open nelsonic opened 7 years ago

nelsonic commented 7 years ago

Need to write a detailed comparison of GitHub Wikis vs Readmes (markdown files inside the Git Repo) ... e.g: https://github.com/hapijs/hapi/wiki https://github.com/hapijs/hapi/blob/master/API.md

jay-meister commented 7 years ago

@nelsonic in line with the concern that there can be too much documentation to read, i would also suggest you simply ask anyone who is starting a dwyl project for the first time to use a readme/docs folder as opposed to the wiki. I see no need not to reference your said detailed comparison, but for simplicity, the developer may appreciate being clearly instructed some dos/donts with the option to read more or question the decision if they please.

nelsonic commented 7 years ago

@JMurphyWeb I totally agree we need to do a much better job of setting expectations regarding documenting projects before people start. Thanks for highlighting this and for being patient! 👍 ❤️