Hacker News new | past | comments | ask | show | jobs | submit login
Software Packaging Guidelines (zorbash.com)
4 points by zorbash on Jan 20, 2017 | hide | past | web | favorite | 2 comments



Good list, seems to cover many important things that are not language/OS/ecosystem-dependent.

One thing I'd like to add: in your Readme, put information how you can find further documentation (and if it is in the same repo, how it is built). A surprising number of projects have some basic instructions in the readme, and then a /documentation folder or an external website, without any clear reference to it.


I agree, I think I'll update the post with your suggestions.

A common pattern out there, is projects keeping some documentation in their repo's wiki and not mentioning it in the Readme. Unfortunately GitHub does not provide a visual hint on how often a wiki is updated in the repo page.




Applications are open for YC Winter 2020

Guidelines | FAQ | Support | API | Security | Lists | Bookmarklet | Legal | Apply to YC | Contact

Search: