search

polifonia-project / stories

Other
10 stars 9 forks source link

Policy for naming folders and files #13

Open valecarriero opened 3 years ago

valecarriero commented 3 years ago

Both folders and files adopt different naming policies: we should define a "final" policy, and update the README if needed

My incomplete proposal: I guess it's best to avoid white spaces when naming folders and files, and I guess that the number in the name of the story can be avoided, but only if we can predict that each story of the same persona will have a different main goal, thus it's the main goal that makes the name of the story unique

e.g. FOLDERS Carolina: Music Historian Patrizia:ethnoantrhropologist anna:hearing-impaired

FILES Keoma#1_RestorationAndSoundPractices.md Sophia#MusiciansAndTheirEnvironment.md William#1 EuropeanFolkMusic.md CreateRelevantCorpus.md

enridaga commented 3 years ago

My opinion:

FOLDERS

FILES

marilenadaquino commented 3 years ago

My2Cents Folders: {Name}: {main role} (shall we keep the space after colon and multi/compound words?) Files: {Name}#{IDscenario} (keep the hashtag, no spaces, and do not use numbers if not needed)

albertmeronyo commented 3 years ago

Sorry to be the party pooper :-) But if files within a folder always relate to the same persona, isn't repeating the name redundant?

Carolina: Music Historian / My scenario.md

valecarriero commented 3 years ago

Sorry to be the party pooper :-) But if files within a folder always relate to the same persona, isn't repeating the name redundant?

Carolina: Music Historian / My scenario.md

If we just navigate on GitHub, yes, but if we need to make a list of stories (e.g. in the general README file), or to compare different stories at the same time, I think that repeating the name can be useful to avoid getting lost :D

enridaga commented 3 years ago

No hash please in file names, creates the opportunity for malformed/bad links

enridaga commented 3 years ago

I am open to remove spaces in favour of camel case, if we want to be geeky, otherwise using spaces will make this more readable to people less familiar with coding conventions ... (but again, I am OK if we go for removing spaces)

valecarriero commented 3 years ago

My opinion:

FOLDERS

  • Carolina: Music Historian

FILES

  • Sophia - Musicians and their environment.md

If it doesn't really make sense to avoid spaces in this case, I'm okay with these conventions.

valecarriero commented 3 years ago

After cloning the repo, I discovered that the colon in folder names is "translated" as a slash by Mac OS (at least, the version I have), so e.g. the folder name "William: Curator Europeana" becomes "William/ Curator Europeana" If I copy the whole path, it is correct, but maybe we should find another separator?

image

marilenadaquino commented 3 years ago

If I may, I'd avoid any separators that are not underscore, I'd use only lowercase and make names shorter. E.g.

Folders:carolina

Files : european_folk_music.md