This is where the description of the project should go. This should make clear why the repository exists.
Usage
Getting Started
Testing
Deploying
Contributing
This section should have usage instructions if this is a tool.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What's needed in your local environment before installing the project.
How to install the project
What one should do to get the project running locally.
Instructions on how one would deploy this codebase if it is a piece of infrastructure.
This should have instructions on how to test this repository.
Requirements to commit here:
- Branch off master, PR back to master.
- Your code should pass Flake8.
- Unit test coverage is required.
- Good docstrs are required.
- Good commit messages are required.