google / atheris

Apache License 2.0
1.35k stars 112 forks source link

Markdown autodocs #19

Closed dineshsonachalam closed 2 years ago

dineshsonachalam commented 3 years ago

Problem with updating Markdown tables or Code block in your README.md

To make your repo more appealing and, useful you need to provide Table or example code snippets in your README.md. Manually copy and pasting each code snippet or adding a table row in their respective places in your README would be inefficient and time-consuming.

Solution to this problem:

This problem can be solved using markdown-autodocs GitHub Action that is created by me that automatically generates & updates markdown content (like your README.md) from external or remote files. You need to add markers in your README.md that will tell markdown-autodocs where to insert the code snippet or transform JSON to HTML table.

Markdown Autodocs GitHub action: https://github.com/dineshsonachalam/markdown-autodocs

To test or experiment markdown-autodocs without Github action: https://github.com/dineshsonachalam/markdown-autodocs#local-usage-without-github-action

Please let me know if any changes are required and will be happy to help.

google-cla[bot] commented 3 years ago

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

:memo: Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.


What to do if you already signed the CLA

Individual signers
Corporate signers

ℹ️ Googlers: Go here for more info.

dineshsonachalam commented 2 years ago

@googlebot I signed it!

google-cla[bot] commented 2 years ago

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

dineshsonachalam commented 2 years ago

@googlebot I signed it!

google-cla[bot] commented 2 years ago

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

dineshsonachalam commented 2 years ago

@googlebot I signed it!

google-cla[bot] commented 2 years ago

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.

dineshsonachalam commented 2 years ago

@googlebot I fixed it.

google-cla[bot] commented 2 years ago

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for all the commit author(s) or Co-authors. If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google. In order to pass this check, please resolve this problem and then comment @googlebot I fixed it.. If the bot doesn't comment, it means it doesn't think anything has changed.

ℹ️ Googlers: Go here for more info.