A little info about your project and/ or overview that explains what the project is about.
- Description
- Requirements
- Installation
- Teamwork Guidelines
- Features
- Screenshots
- How to use? / Quick Use Guide
- Design/Architecture/Framework (Development)
- Tests
- Credits
A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.
System requirements to run application
Provide step by step series of examples and explanations about how to get a development env running.
Maintain a complete overview of all the projects and resources by quantifying hours and accomplishments.
Store project documents and templates for reusable documents, like Unit Tests.
Visualize project development; how much has been done, what is being worked on and what comes next.
The board is divided into a minimum of 3 columns: To-Dos, In Progress and Finished.
Backlog is maintained by the Teamwork system itself so no column is necesarry.
Teamwork Tasks should be linked to the corresponding section in the Readme.
What makes your project stand out?
Include logo/demo screenshot etc.
If people like your project they’ll want to learn how they can use it. To do so include step by step guide to use your project.
Build shown by releases, updates, patches and future development plans.
Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.
Function of this module, what is its purpose.
If you're using any code style like xo, standard etc. That will help others while contributing to your project. Ex. -
Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.
Describe and show how to run the tests with code examples.
| Test | Date | Description | Changes | Run Time | Issues | Possible Fixes |
|---|---|---|---|---|---|---|
| Test #1 | MM/DD/YYYY | Objective of the test | What changes have been implemented since the previous test | How long it took to run the test | Where did the test stop? Did it reach it's goal? | Brainstorm possible solutions |
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
Give proper credits. This could be a link to any repo which inspired you to build this project, any blogposts or links to people who contributed in this project.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent
