ソースを参照

Provide guidance for naming modules

Name a module after the software it provides, not the functionality it
provides.  This allows alternative software providing the same
functionality to be located in Sovereign.
Mike Ashley 8年前
コミット
37a85a8deb
1個のファイルの変更4行の追加0行の削除
  1. 4
    0
      CONTRIBUTING.md

+ 4
- 0
CONTRIBUTING.md ファイルの表示

@@ -14,6 +14,10 @@ You'll want to set up a [local development environment](https://github.com/sover
14 14
 
15 15
 Sovereign is an Ansible playbook that uses the modules in this repository to configure a server. Modules should conform to the following design principles.
16 16
 
17
+### Naming
18
+
19
+Modules should be named after the software they add (as opposed to the functionality they provide). Soverign is currently inconsistent on this. For example, there are the `ircbouncer` and `blog` modules, but there are also the `owncloud` and `tarsnap` modules. Please name modules after the software used, though, so that it is possible to provide alternatives for functionality.
20
+
17 21
 ### Making decisions
18 22
 
19 23
 A module exists to make decisions about how a service should be installed and configured. Make these decisions and minimize or eliminate configuration options exposed to the user. When in doubt, make a decision, and if the community feedback is vocal enough, only then expose an option.

読み込み中…
キャンセル
保存