Repository Set-up

Repository Handle

• [ ] Repository handle clearly reflects what’s inside.
  • If the repository is part of a larger project, use a shared prefix to indicate this.
  • Use - dashes to separate words, not underscore _ or . periods
  • For example
    • ❌ sdk-js ⇒ ✅ cere-ddc-sdk-js
    • ❌ game_demo ⇒ ✅ cere-ddc-tower-blocks-game
    • ❌ web-loader ⇒ ✅ cere-ddc-web-app-loader

Title ~ ≤30c or ~ ≤ 5 Words

• [ ] Title accurately describes the contents of repository such that most are able to guess what’s inside without first needing to open it.

About

• [ ] Description ~ ≤ 150c or ~ ≤ 20 words
  • [ ] Description, in combination with Title should make it 100% clear to most what contents are inside the repository without needing to open it.
• [ ] Website
• [ ] Topics
• [ ] Include in Home Page (what is/will be used for each project)

Readme file (README.md)

• [ ] Title
• [ ] Version (describe how versioning will work)
• [ ] Banner image (optional)
• [ ] Badge images (optional)
• [ ] Medium Description < 740c
• [ ] Table of Contents (optional)
• [ ] Requirements
• [ ] Build
• [ ] Install