GitHub Readme File

This is the standard elements that a README.md file in the Kolibri Network repository must follow

Required

This elements are mandatory, but depends the project.

  • Title of the Project

  • Shields Labels

    • Project Framework / Library
    • Manual Shield Codename of the project (Public repos only)
    • Release Status
    • Open Issues
    • Open Pull Requests

  • Subject of the Project

  • Description of the project / repository

  • Instructions

  • A list with minimum five codenames for the project to give context

Codenames list example:

v0.0.0 Name
v1.0.0 Name
v2.0.0 Name
v3.0.0 Name
v4.0.0 Name
v5.0.0 Name
Edit this page