- What does this project do?
- Who is it for? What goals does this accomplish?
- Requirements for running the project
- What technologies are you using?
- Frontend/Backend key libraries that are good to know.
- Add links to their documentation if you can example VueJS Docs
- How can I get started running this project?
- How did you set up the project?
- Where is key logic happening?
- What are you integrating with?
Testing / Formatting
- What kind of tests does this have? What formatting rules should I follow?
- Confusing parts of the repo.