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.

Sign up for GitHub

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

Jump to bottom

Update documentation to follow templates from other repos #5

Open
dalmia opened this issue Nov 9, 2021 · 0 comments
Open

Update documentation to follow templates from other repos #5

dalmia opened this issue Nov 9, 2021 · 0 comments

Comments

@dalmia
Copy link
Member

dalmia commented Nov 9, 2021

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dalmia