search

youtube / spfjs

A lightweight JS framework for fast navigation and page updates from YouTube
https://youtube.github.io/spfjs/
MIT License
2.24k stars 147 forks source link

Add docs badge to README #298

Closed rrrene closed 8 years ago

rrrene commented 9 years ago

Hi there,

I want to propose to add this badge to the README to show off inline-documentation: Inline docs

The badge links to Inch CI and shows an evaluation by InchJS, a project that tries to raise the visibility of inline-docs. Besides testing and other coverage, documenting your code is often neglected although it is a very engaging part of Open Source that encourages aspiring developers to jump into the source and see how it all ties together.

So far over 600 Ruby projects are sporting these badges to raise awareness for the importance of inline-docs and to show potential contributors that they can expect a certain level of code documentation when they dive into your project's code and motivate them to eventually document their own. I would really like to do the same for the JavaScript community and roll out support for JS over the coming weeks (early adopters are forever, node-sass and when).

Although this is "only" a passion project, I really would like to hear your thoughts, critique and suggestions. Your status page is http://inch-ci.org/github/youtube/spfjs

What do you think?

nicksay commented 8 years ago

Hi René,

Sorry for long delay here; we'd be happy to add this badge. Before we can accept your patch, will you please sign a contributor license agreement? You may choose from either individual (https://cla.developers.google.com/about/google-individual) or corporate (https://cla.developers.google.com/about/google-corporate) depending on whether you're submitting this on behalf of yourself or a company, respectively.

Thanks!

nicksay commented 8 years ago

Hi @rrrene, just wanted to check on this patch. Would you like to sign the CLA? Thanks!

nicksay commented 8 years ago

Hi @rrrene, following up here again. Would you like to sign the CLA in order to land this patch?

rrrene commented 8 years ago

Hi, yikes, I really did not participate here, did I? :cold_sweat:

I just signed the CLA!

nicksay commented 8 years ago

No problem at all! We were much slower on the initial PR in the first place. Would you mind syncing up to the latest version?

rrrene commented 8 years ago

Done :+1: