DfE-DAU / dau-git-hub-best-practice

Place to discuss the best practice for using git and GitHub in DAU
GNU General Public License v3.0
0 stars 0 forks source link

Naming Conventions for GiT projects #1

Open BASuk opened 5 months ago

BASuk commented 5 months ago

What naming convention should we use for projects stored on our github?

Such as function_all_schools or analysis_2ri_changes?

Open to ideas and suggestions, but the idea is we need to make sure that each git is recognisable for what it does

JT-39 commented 5 months ago

I personally prefer a dash - rather than an underscore _ as it is easier to read for humans and more suitable for webpages/ urls. https://x-equals.com/dashes-versus-underscores/

Also Posit use this (from my brief check) for repo names: https://github.com/orgs/rstudio/repositories

P.S. But I do think that for folders and files within the repo should use _