Skip to content

Latest commit

 

History

History
28 lines (18 loc) · 1.15 KB

PROJECT_NOMENCLATURE.md

File metadata and controls

28 lines (18 loc) · 1.15 KB
Raw

Project Nomenclature

The objective is to ensure easier navigation through a naming convention that makes sense for typical use cases.

TLDR;

  • Lower-case only
  • Use hyphens ("-") not underscores ("_")
    • Unless project specific conventions demand otherwise (Eg. ROS package standards)
  • Use logical naming conventions (use common sense, and keep in mind the large variety of repositories. Don't be too generic e.g. "AI-UROP")
  • Write good project descriptions and README.md

Key Repositories

Community

Propose having a common theme that reflects the goals of OpenSUTD throughout all naming conventions. This could resonate with a common mascot such as Wapuu to give OpenSUTD a friendly community vibe.

Course Material

It's like eDimension but better!

  • Courses with their code and canonical name, e.g. 10.001 Advanced Math I
  • Lecture slides should have the week number and a descriptive filename, e.g. Week 10 - James Scott - Commentary on Jacob's work.pdf
  • Subdirectories as needed, e.g. /Additional Readings or /src

Fifth Rows

Recommend crowdsourcing ideas on this.