skonfig / base

explorer and types for general use
GNU General Public License v3.0
4 stars 4 forks source link

Draft cdist coding conventions (for types and explorers) #1

Open sideeffect42 opened 2 years ago

sideeffect42 commented 2 years ago

Different types currently use different coding conventions (sometimes even different conventions in the same file). In the future it would be a plus to have agreed on coding conventions.

Some points that should be included:

4nd3r commented 2 years ago

my proposal:

4nd3r commented 2 years ago

Another thing: file headers?

We have two choices:

  1. Enforce copyright (?), license and other info in (almost) every file.
  2. Only add # This file is part of cdist. See documentation for more information. when possible.

I feel that second choice is more reasonable. For type's man.rst we already have this information included (e.g. all current and historical authors). There's also LICENSE in repo. Or do we really need to duplicate this to every file at all? What does GPL say about it?

See #5. I removed headers, updated man.rst with all the authors (in alphabetical order) etc. Decided to remove mail addresses, because we shouldn't try to be address book.