New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Establish README Guidelines / Standard #33
Comments
Here's my initial proposal for discussion: https://github.com/expressjs/expressjs.com/wiki/Proposed-README-Guidelines-and-Template. A few sections have comments labeled "For discussion". I believe in the TC meeting, @dougwilson mentioned some other README spec/template, but I don't recall the specifics. If you want to link to it for comparison, we can fold that into the discussion. |
Awesome write up, @crandmck! I'll take a look over the weekend here :) Also, though I haven't really read it completely yet, here is that link I promised for the "standard readme" project: https://github.com/RichardLitt/standard-readme |
@crandmck from our meeting I had wrote up https://github.com/mysqljs/mysql#contributing semi-recently and think it's a good jumping off point for a contributing / tests section. |
closing, as we have a readme and contributing section already. please re-open if that is not the case |
Per TC discussion in (see #32), we'd like to have some general standards for README organization, content, style, and formatting. Let's discuss here.
The text was updated successfully, but these errors were encountered: