Skip to content

Add Readme guidelines#3209

Closed
crandmck wants to merge 1 commit intomasterfrom
readme-guidelines
Closed

Add Readme guidelines#3209
crandmck wants to merge 1 commit intomasterfrom
readme-guidelines

Conversation

@crandmck
Copy link
Member

@crandmck crandmck commented Feb 16, 2017

Per expressjs/discussions#33 and expressjs/discussions#51 this PR adds a new README-guidelines.md file with the content of the previously-reviewed file from the expressjs.com wiki. In this file, I added the "Contributing" section from https://github.com/mysqljs/mysql#contributing as suggested by @dougwilson

The README guidelines refers to a new README template in the wiki in this repo.

I made a few small related changes:

  • Added a reference to StandardJS to the Collaborator-Guide.md since the TC adopted this as our style, but it was not mentioned anywhere.
  • Edited Contributing.md to remove text carried over from Node.js project, and make it more specific to Express.js project, plus some minor wording edits.

@expressjs/express-tc

@dougwilson dougwilson added pr docs Documentations issues labels Feb 16, 2017
@dougwilson
Copy link
Contributor

Hey @crandmck just if you were wondering, I merged the simple edits to Contributing.md already, and this PR is the bits that remain :)

@crandmck
Copy link
Member Author

Thanks @dougwilson ... So can we land this PR? Or do I need to make some changes...?

@dougwilson
Copy link
Contributor

Sorry, didn't get to really reading through the changes until now. My only comments are just minor tweaks, so not sure if you want to go through changes or just have me make them on landing (similar to expressjs.com PRs).

@dougwilson
Copy link
Contributor

I guess I can update the PR directly as well :)

@dougwilson dougwilson self-assigned this Feb 20, 2017
@dougwilson dougwilson deleted the readme-guidelines branch February 20, 2017 23:23
@crandmck
Copy link
Member Author

Thanks @dougwilson

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentations issues pr

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants