Explain what this repository is for, is it for a specific customer, an internal project or just a simple hobby project?
Describe what the solution is doing. What are important parts of code that your peers need to understand? What is specific information for this customer?
How can your colleagues use this code?
If your solution results in a visualization of some sorts. Add a picture to the repository and talk your audience through. A picture says more than a thousand words!
Make a list of whatever is important for you to do before this goes into production. Let's help you get started with that!
- Create Documentation
- Label repository
- Configure CI/CD for solution