Skip to content

style_guide_github.md

Latest commit

 

History

History
26 lines (20 loc) · 572 Bytes

style_guide_github.md

File metadata and controls

26 lines (20 loc) · 572 Bytes

Style Guide for Github

Rule

  • Familiarize with the suggested style guide for Github
  • Add minimum necessary files to make your repository sustainable and easy to maintain
    • README.md
    • .gitignore
    • dependency.repos
    • LICENSE
  • Add additional files to your repository if you are considering to collaborate outside the group
    • workflows
    • Documentation
    • Doxygen

README.md

Use the below template to provide users with minimal yet necessary information about your code.

# Repository Name

## Prerequisites

## Installation

## Run