There should be a proper README, with details like About the app, Dependencies and Installation, Building and Running, Contributing
About the App - Write what the app does and the features it has and what is the use the app fullfils
Dependencies and Installation - The technologies used and the proper links or terminal commands to get the software and libraries installed on the local machine.
Building and Running - The required commands after cloning the app to get it up and running in the development environment. This will include db migration and editing config files and local necessary changes
Contributing - Refers to the workflow for contributinh to the app. This will include opening issues for bugs and feature requests, details about PRs like commit messages should include the issue number it solves and other required conventions for uniform workflow.
There should be a proper README, with details like About the app, Dependencies and Installation, Building and Running, Contributing
About the App - Write what the app does and the features it has and what is the use the app fullfils Dependencies and Installation - The technologies used and the proper links or terminal commands to get the software and libraries installed on the local machine. Building and Running - The required commands after cloning the app to get it up and running in the development environment. This will include db migration and editing config files and local necessary changes Contributing - Refers to the workflow for contributinh to the app. This will include opening issues for bugs and feature requests, details about PRs like commit messages should include the issue number it solves and other required conventions for uniform workflow.