Enhance docs - Githubissues

src-d / lookout-sdk

SDK for lookout analyzers

Apache License 2.0

4 stars 11 forks source link

Enhance docs #45

Closed dpordomingo closed 5 years ago

dpordomingo commented 5 years ago

caused by https://github.com/src-d/lookout/issues/330 blocks https://github.com/src-d/lookout/pull/398

I did:

added the .github/CODE_OF_CONDUCT.md file,
moved the example analyzers into examples dir,
fixed the LICENSE.md file, and created the NOTICE.md file,
added the DCO file,
added the CONTRIBUTING.md file
added the make toc rule into the `Makefile,
enhanced the README.md considering that source{d} lookout docs will be in src-d/lookout repo,

dpordomingo commented 5 years ago

Thanks for your reviews; I addressed all your suggestions and posted two questions. (DCO problem now because accepting suggestions; I'll fix it once the PR has been accepted)

smacker commented 5 years ago

sorry for the late comment but I just opened readme once again and I don't see much value in toc. The readme is small enough now that toc becomes just a noise for me. (no need to take any actions in this PR but if you think the same we can update it later)