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

Update README/package.json files #101

Merged
merged 5 commits into from
May 21, 2018
Merged

Conversation

JamesLefrere
Copy link
Contributor

Description

This PR updates all README files so that they are written in the same style and link to the colonyJS docs site where appropriate.

Other changes (e.g. bug fixes, UI tweaks, refactors)

  • Renames Readme.md to README.md (just so we have a standard)
  • Replaces author with contributors in all package.json files
  • Replaces references to colony-js on Github

Contributes to #100

Copy link
Member

@rdig rdig left a comment

Choose a reason for hiding this comment

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

Looks good to me 💯

@@ -32,6 +32,7 @@
"webpack": "^4.5.0",
"webpack-cli": "^2.0.14"
},
"contributors": ["Christian Maniewski <chris@colony.io>", "James Lefrère <james@colony.io>"],
Copy link
Member

Choose a reason for hiding this comment

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

This should be authors, as contributors are a lot more: https://github.com/JoinColony/colonyJS/graphs/contributors

Copy link
Member

Choose a reason for hiding this comment

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

Oh, I just now read the PR's description:

Replaces author with contributors in all package.json files

Weird...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True! But then again, they didn't directly contribute to our repo 🙃

npm just references author or contributors, so I guess we can go with this? https://docs.npmjs.com/files/package.json

Copy link
Member

Choose a reason for hiding this comment

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

But what happens when there are "real" contributors ? :)

@JamesLefrere JamesLefrere merged commit 9052ea8 into master May 21, 2018
@JamesLefrere JamesLefrere deleted the maintenance/update-readmes branch May 21, 2018 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants