SDD 0024: Document new Tool Naming Scheme

projectsyn / documentation

The Project Syn main documentation repository

https://docs.syn.tools/

BSD 3-Clause "New" or "Revised" License

6 stars 3 forks source link

SDD 0024: Document new Tool Naming Scheme #107

Closed tobru closed 3 years ago

tobru commented 3 years ago

New SDD describing the new tool naming scheme.

Addresses and closes #106

Checklist

[X] Keep pull requests small so they can be easily reviewed.
[X] Update the documentation.
[X] Link this PR to related issues.

tobru commented 3 years ago

What I don't like yet is the fact that the Project Syn CLI would end up being named syn-cli whereas there would be much nicer names like synctl. Otoh this naming scheme mainly describes the name of the tool but not of the binary :smile: It would be confusing for sure.

We might find a simpler naming scheme? This proposed one feels a bit to strict to me. And ideas?

srueg commented 3 years ago

We might find a simpler naming scheme? This proposed one feels a bit to strict to me. And ideas?

We could just loosely define it: The name must contain the word "syn", the type of the tool and it should contain the purpose if possible.

tobru commented 3 years ago

Thanks @simu for the good input, I incorporated your idea into the proposal and I personally like it now very much :+1:

tobru commented 3 years ago

After reading the latest comments I wasn't satisfied with the proposed naming scheme anymore, it was just to strict IMHO. So I split it up into "Display Name" and "Binary Name" and have made it less strict. WDYT? Pinging the recent commenters @simu @corvus-ch