Skip to content
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

docs: Add CONTRIBUTE, edit README, update LICENSE year #1155

Merged
merged 5 commits into from
Jul 2, 2018

Conversation

RichardLitt
Copy link
Member

This commit adds a CONTRIBUTE file by pulling most of the content out of the README file. It also updates the year for the LICENSE file; adjusts the depth of the headings across the board; and implements a few small wording changes in the README.

This is related to #1154.

This commit adds a CONTRIBUTE file by pulling most of the content out of the README file. It also updates the year for the LICENSE file; adjusts the depth of the headings across the board; and implements a few small wording changes in the README.
@gr2m
Copy link
Member

gr2m commented Jun 29, 2018

I’m not 100% sure, but I think the file name must be CONTRIBUTING.md in order for GitHub to recognize it: https://help.github.com/articles/setting-guidelines-for-repository-contributors/

Copy link
Member

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you remove the package-lock.json for the pull request? Other than that I only have a few comments :) Thanks!

LICENSE Outdated
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2017 Pedro Teixeira and other contributors
Copyright (c) 2017-2018 Pedro Teixeira and other contributors
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if we do a time frame let’s do 2011-2018. First release was on Sep 22, 2011

README.md Outdated
# Contributing
## Contributing

Thanks for wanting to contribute! Take a look at our [Contributing Guide](CONTIRBUTE.md) for notes on our commit message conventions and how to run tests.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in case we rename the file make sure to update the link here

@RichardLitt
Copy link
Member Author

Updated all three files. Good catches!

Copy link
Member

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fabulous, thanks!

@gr2m gr2m merged commit 5aa1081 into nock:master Jul 2, 2018
@gr2m gr2m deleted the feat/doc-audit branch July 2, 2018 17:03
@lock
Copy link

lock bot commented Sep 13, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue and add a reference to this one if it’s related. Thank you!

@lock lock bot locked as resolved and limited conversation to collaborators Sep 13, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants