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

adding an Introduction to the README #140

Merged
merged 5 commits into from
Mar 5, 2017
Merged

Conversation

mfrasca
Copy link
Contributor

@mfrasca mfrasca commented Feb 17, 2017

I'm trying to describe my understanding of the logic, structure and usage of this plugin, hoping it will help others, but also so that next time I have to use it, I will find the readme I missed the first time I came here.

@jsf-clabot
Copy link

jsf-clabot commented Feb 17, 2017

CLA assistant check
All committers have signed the CLA.

@mfrasca mfrasca changed the title adding an introduction tot he README adding an Introduction to the README Feb 17, 2017
@Arkni
Copy link
Member

Arkni commented Feb 21, 2017

Thanks for your contribution! I'll take a look at it as soon as possible!

@Arkni Arkni self-requested a review February 21, 2017 12:06
@Arkni
Copy link
Member

Arkni commented Feb 25, 2017

Hi @mfrasca
Finally got some time to review this PR.

Lets start with some information about how the documentation is handled in grunt-contrib-* plugins.
All of the grunt-contrib-* plugins use grunt-contrib-internal to construct the README.md and CONTRIBUTING.md files. The source files are located in the corresponding docs/ folder.

Which means, you need to edit the source files rather than the README directly.

Your changes can be summarized in the following steps:

  1. The introduction should be added in top of the file docs/qunit-overview.md alongside the other changes about configuring the task and the installation of PhantomJS.
  2. The options updates should happen in the file docs/qunit-options.md, but please don't change the type of httpBase to Boolean. In fact, it should be a String and the default value should be changed to empty string "", which I will do after merging this PR.
  3. Run grunt to generate the new README.md file and commit all files

Thanks.


Note:
If your editor removes trilling white spaces from markdown files (especially the ones we use at the end of the type of every option), then replace them with <br>.

@mfrasca
Copy link
Contributor Author

mfrasca commented Mar 4, 2017

ok. seen. will make time to contribute my edits the way you indicate. :-)

@Arkni Arkni merged commit f28e09d into gruntjs:master Mar 5, 2017
@Arkni Arkni removed their request for review March 5, 2017 19:28
@Arkni
Copy link
Member

Arkni commented Mar 5, 2017

I removed one unrelated paragraph (the one about coveralls) and squashed the commits.

Thanks again for your contribution!

@Arkni Arkni removed the in progress label Mar 30, 2017
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.

3 participants