avantifellows/auth-to-bigquery

Update documentation to follow templates from other repos

Opened this issue · 0 comments

dalmia commented

Updates to the README needed:

  • include the heading for the repo
  • add a description
  • add a summary for what the code is doing
  • good to have: add a flow diagram
  • move the pre-commit documentation to a separate PRE-COMMIT.md file and link it under the Contribution section.