Copy-edit README.md Issue: #11168 #12043

LeaSak · 2017-10-24T09:47:48Z

Hello. I've copy-edited the README.md. These are just suggestions. Besides correcting some grammar and punctuation, I tried to reduce the length of some sentences and the use of passive to help improve readability. I also fixed the link to the API docs.

Pull request for issue: #11168
Related issue(s): # #

Checklist for Pull request or lib adding request issue follows the conventions.

Note that if you are using a distribution purpose repository/package, please also provide the url and other related info like popularity of the source code repo/package.

Profile of the lib

Git repository (required):
Official website (optional, not the repository):
NPM package url (optional):
License and its reference:
GitHub / Bitbucket popularity (required):
- Count of watchers:
- Count of stars:
- Count of forks:
NPM download stats (optional):
- Downloads in the last day:
- Downloads in the last week:
- Downloads in the last month:

Essential checklist

I'm the author of this library
- I would like to add link to the page of this library on CDNJS on website / readme
This lib was not found on cdnjs repo
No already exist / duplicated issue and PR
The lib has notable popularity
- More than 200 [Stars / Watchers / Forks] on [GitHub / Bitbucket]
- More than 800 downloads stats per month on npm registry
Project has public repository on famous online hosting platform (or been hosted on npm)

Auto-update checklist

Has valid tags for each versions (for git auto-update)
Auto-update setup
Auto-update target/source is valid.
Auto-update filemap is correct.

Git commit checklist

[x ] The first line of commit message is less then 50 chars, be clean and clear, easy to understand.
[x ] The parent of the commit(s) in the PR is not old than 3 days.
[ x] Pull request is sending from a non-master branch with meaningful name.
Separate unrelated changes into different commits.
Use rebase to squash/fixup dummy/unnecessary commits into only one commit.
Close corresponding issue in commit message
[ X] Mention related issue(s), people in commit message, comment.

PeterBot

@LeaSak congratulations! 3393ce2 CI test passed! ✅
Please wait for the further review from the maintainers!

For the details 📃, please take a look at ➡️ https://ci.cdnjs.com/cdnjs/cdnjs/14238, thank you 😀

maruilian11 · 2017-10-26T13:22:20Z

Great! Thank you so much.

maruilian11 · 2017-10-26T13:24:36Z

@LeaSak Could you modify the issue number in commit msg to #11168? Then, I think everything is wonderful. 😄

PeterBot

Oops 😨 d3b8445 CI test failed ❗

@LeaSak please take a look at CI build https://ci.cdnjs.com/cdnjs/cdnjs/14375 for details 📝 !
Most of the error will have corresponding explanation, so that you will know what's wrong and then try to fix it!
If you cannot understand the error message and need help, feel free to ask our maintainers ☺️

PeterBot

@LeaSak congratulations! 6165426 CI test passed! ✅
Please wait for the further review from the maintainers!

For the details 📃, please take a look at ➡️ https://ci.cdnjs.com/cdnjs/cdnjs/14378, thank you 😀

LeaSak · 2017-10-26T21:06:31Z

Hi @maruilian11. I managed to modify the commit message and learn a bit more about git in the meantime 😃

PeterBot

@LeaSak congratulations! c7943ba CI test passed! ✅
Please wait for the further review from the maintainers!

For the details 📃, please take a look at ➡️ https://ci.cdnjs.com/cdnjs/cdnjs/14472, thank you 😀

maruilian11

I think this PR is great.

PeterDaveHello · 2017-10-31T14:18:19Z

README.md


-CDNJS is a free and open source project to organize all the famous web front-end development resources and provide them to the developers with faster CDN infrastructure without usage limitation and fee. We want to help individual library/framework developers spread their projects, and help web developers to supercharge their websites! With the great and free CDN service, developers can focus on the project and website development, without spending time worrying about how to setup a CDN for the project or website assets. We hope to make web development easier, your websites and the WWW faster and safer.
+CDNJS is a free open-source project to organize and provide all famous front-end web development resources to developers via a fast CDN infrastructure without usage limitations and fees. We want to help individual library/framework developers distribute their projects, and web developers supercharge their websites! With our great free CDN service, developers can focus on their projects and website development. Developers no longer have to spend time worrying about how to set-up a CDN for projects or website assets. We hope to make web development easier, as well as your websites and the WWW faster and safer.


hmmm, I suppose we usually use the common term free and open source project instead of free open-source project?

Hi @PeterDaveHello. Sure, I can fix that if you like. Also, in my PR I capitalized the acronym url to URL in all cases in the README body except for in the Table of Contents. The comments mentioned not to touch this section manually. Should I keep this change or switch it back to how it was beforehand to be consistent with the Table of Contents item?

Thanks, let's change it back!

It's fine if you'd like to update the Table of Contents :)

Ok, great. Just one last question from a beginner. Should I squash the new commit with the above changes with my first commit on my branch after I make my changes?

@LeaSak Yes, we hope the commits can be as clean as possible. Could you please squash them? Thanks.

Thanks @maruilian11 for helping me. I just squashed the commits.

petrgazarov

Good to see this cleaned up! One comment below, otherwise LGTM

petrgazarov · 2017-11-01T01:30:39Z

README.md


-CDNJS is a free and open source project to organize all the famous web front-end development resources and provide them to the developers with faster CDN infrastructure without usage limitation and fee. We want to help individual library/framework developers spread their projects, and help web developers to supercharge their websites! With the great and free CDN service, developers can focus on the project and website development, without spending time worrying about how to setup a CDN for the project or website assets. We hope to make web development easier, your websites and the WWW faster and safer.
+CDNJS is a free open-source project to organize and provide all famous front-end web development resources to developers via a fast CDN infrastructure without usage limitations and fees. We want to help individual library/framework developers distribute their projects, and web developers supercharge their websites! With our great free CDN service, developers can focus on their projects and website development. Developers no longer have to spend time worrying about how to set-up a CDN for projects or website assets. We hope to make web development easier, as well as your websites and the WWW faster and safer.


and provide all famous front-end web development resources to developers

~~all famous~~ -> popular

Actors and celebrities can be described as "famous", but with software libraries it sounds a bit comical

Agree. I'll swap the word. No problem.

PeterBot

@LeaSak congratulations! 632859f CI test passed! ✅
Please wait for the further review from the maintainers!

For the details 📃, please take a look at ➡️ https://ci.cdnjs.com/cdnjs/cdnjs/14636, thank you 😀

PeterBot

@LeaSak congratulations! fef0c65 CI test passed! ✅
Please wait for the further review from the maintainers!

For the details 📃, please take a look at ➡️ https://ci.cdnjs.com/cdnjs/cdnjs/14637, thank you 😀

PeterBot

@LeaSak congratulations! 6741080 CI test passed! ✅
Please wait for the further review from the maintainers!

For the details 📃, please take a look at ➡️ https://ci.cdnjs.com/cdnjs/cdnjs/14757, thank you 😀

dakshshah96

LGTM

PeterDaveHello · 2017-11-06T16:47:39Z

README.md


-**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
+**Working on your first Pull Request?** Learn how from this *free* series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)


This was copied from http://makeapullrequest.com/ actually, but I won't mind if we have better wording.

PeterDaveHello

Awesome 👍

LeaSak · 2017-11-06T20:20:27Z

Thanks for everyone's help and patience. This is exciting.

PeterDaveHello · 2017-11-06T20:32:01Z

@LeaSak Thank you for your contribution 😄

PeterBot requested review from dakshshah96, extend1994, maruilian11, sashberd and sufuf3 October 24, 2017 09:47

PeterBot approved these changes Oct 24, 2017

View reviewed changes

LeaSak force-pushed the edit-readme-#11168 branch from 3393ce2 to d3b8445 Compare October 26, 2017 19:43

PeterBot suggested changes Oct 26, 2017

View reviewed changes

LeaSak force-pushed the edit-readme-#11168 branch from d3b8445 to 6165426 Compare October 26, 2017 20:58

PeterBot approved these changes Oct 26, 2017

View reviewed changes

maruilian11 force-pushed the edit-readme-#11168 branch from 6165426 to c7943ba Compare October 30, 2017 09:00

ghost assigned maruilian11 Oct 30, 2017

ghost added the in progress label Oct 30, 2017

PeterBot approved these changes Oct 30, 2017

View reviewed changes

maruilian11 approved these changes Oct 30, 2017

View reviewed changes

maruilian11 requested a review from PeterDaveHello October 30, 2017 09:07

PeterDaveHello reviewed Oct 31, 2017

View reviewed changes

PeterDaveHello requested review from drewfreyling, petrgazarov and mercyg October 31, 2017 14:19

petrgazarov approved these changes Nov 1, 2017

View reviewed changes

LeaSak force-pushed the edit-readme-#11168 branch from c7943ba to 632859f Compare November 2, 2017 10:27

PeterBot approved these changes Nov 2, 2017

View reviewed changes

Copy-edit README.md Issue: cdnjs#11168

6741080

LeaSak force-pushed the edit-readme-#11168 branch from fef0c65 to 6741080 Compare November 5, 2017 21:32

PeterBot approved these changes Nov 5, 2017

View reviewed changes

dakshshah96 approved these changes Nov 6, 2017

View reviewed changes

PeterDaveHello reviewed Nov 6, 2017

View reviewed changes

PeterDaveHello approved these changes Nov 6, 2017

View reviewed changes

PeterDaveHello merged commit 93720e8 into cdnjs:master Nov 6, 2017

ghost removed the in progress label Nov 6, 2017

LeaSak deleted the edit-readme-#11168 branch November 18, 2017 12:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Copy-edit README.md Issue: #11168 #12043

Copy-edit README.md Issue: #11168 #12043

LeaSak commented Oct 24, 2017

PeterBot left a comment

maruilian11 commented Oct 26, 2017 •

edited

maruilian11 commented Oct 26, 2017 •

edited

PeterBot left a comment

PeterBot left a comment

LeaSak commented Oct 26, 2017

PeterBot left a comment

maruilian11 left a comment

PeterDaveHello Oct 31, 2017

LeaSak Oct 31, 2017

PeterDaveHello Oct 31, 2017

LeaSak Oct 31, 2017

maruilian11 Nov 5, 2017

LeaSak Nov 5, 2017

petrgazarov left a comment

petrgazarov Nov 1, 2017

LeaSak Nov 2, 2017

PeterBot left a comment

PeterBot left a comment

PeterBot left a comment

dakshshah96 left a comment

PeterDaveHello Nov 6, 2017

PeterDaveHello left a comment

LeaSak commented Nov 6, 2017

PeterDaveHello commented Nov 6, 2017


		CDNJS is a free and open source project to organize all the famous web front-end development resources and provide them to the developers with faster CDN infrastructure without usage limitation and fee. We want to help individual library/framework developers spread their projects, and help web developers to supercharge their websites! With the great and free CDN service, developers can focus on the project and website development, without spending time worrying about how to setup a CDN for the project or website assets. We hope to make web development easier, your websites and the WWW faster and safer.
		CDNJS is a free open-source project to organize and provide all famous front-end web development resources to developers via a fast CDN infrastructure without usage limitations and fees. We want to help individual library/framework developers distribute their projects, and web developers supercharge their websites! With our great free CDN service, developers can focus on their projects and website development. Developers no longer have to spend time worrying about how to set-up a CDN for projects or website assets. We hope to make web development easier, as well as your websites and the WWW faster and safer.


		Working on your first Pull Request? You can learn how from this free series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
		Working on your first Pull Request? Learn how from this free series: [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)

Copy-edit README.md Issue: #11168 #12043

Copy-edit README.md Issue: #11168 #12043

Conversation

LeaSak commented Oct 24, 2017

Profile of the lib

Essential checklist

Auto-update checklist

Git commit checklist

PeterBot left a comment

Choose a reason for hiding this comment

maruilian11 commented Oct 26, 2017 • edited

maruilian11 commented Oct 26, 2017 • edited

PeterBot left a comment

Choose a reason for hiding this comment

PeterBot left a comment

Choose a reason for hiding this comment

LeaSak commented Oct 26, 2017

PeterBot left a comment

Choose a reason for hiding this comment

maruilian11 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

petrgazarov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PeterBot left a comment

Choose a reason for hiding this comment

PeterBot left a comment

Choose a reason for hiding this comment

PeterBot left a comment

Choose a reason for hiding this comment

dakshshah96 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PeterDaveHello left a comment

Choose a reason for hiding this comment

LeaSak commented Nov 6, 2017

PeterDaveHello commented Nov 6, 2017

maruilian11 commented Oct 26, 2017 •

edited

maruilian11 commented Oct 26, 2017 •

edited