How files and folders are named is one of the biggest contributors to an effective and maintainable repo. Related to a discussion in another repo, we should have a naming scheme.
@dp-next/wp1-team since this is our responsibility, do any of you have suggestions? Some basic ones we use are:
- Favor single words rather than multiple words for files and folders
- Use nouns rather than verbs for folders (mostly relevant to making software, as files could be verbs e.g.
create-data.R)
- Be conservative in adding new sub-folders within sub-folders. Too much nesting likely suggests the sub-folder should be it's own repo.
Related to this is what files to actually store. I notice a lot of PDFs of e.g. papers others have published in some repos. Rather than store those files in the repo, put a link to them in an Issue instead, like an Issue called "Relevant or interesting articles or resources" (or something similar).
How files and folders are named is one of the biggest contributors to an effective and maintainable repo. Related to a discussion in another repo, we should have a naming scheme.
@dp-next/wp1-team since this is our responsibility, do any of you have suggestions? Some basic ones we use are:
create-data.R)Related to this is what files to actually store. I notice a lot of PDFs of e.g. papers others have published in some repos. Rather than store those files in the repo, put a link to them in an Issue instead, like an Issue called "Relevant or interesting articles or resources" (or something similar).