Show last authors
1 = Repolinter =
2
3 We strongly suggest using [[repolinter>>url:https://github.com/todogroup/repolinter]] to ensure your project conforms with typical community standards. An example configuration below enforces:
4
5
6 * A valid known license.
7 * A README file that references the licenses
8 * A CONTRIBUTING file
9 * A Code of Conduct
10 * That binaries are not present
11 * That there are tests and CI
12 * That the source files contain the relevant copyright and an SPDX identifier
13 * That a dependency management system is used.
14
15 (((
16 == Example: ==
17 )))
18
19 {{code}}
20 {
21 "rules": {
22 "all": {
23 "license-file-exists:file-existence": ["error", {"files": ["LICENSE*", "COPYING*"]}],
24 "readme-file-exists:file-existence": ["error", {"files": ["README*"]}],
25 "contributing-file-exists:file-existence": ["error", {"files": ["CONTRIB*"]}],
26 "code-of-conduct-file-exists:file-existence": ["error", {"files": ["CODEOFCONDUCT*", "CODE-OF-CONDUCT*", "CODE_OF_CONDUCT"]}],
27 "readme-references-license:file-contents": ["error", {"files": ["README*"], "content": "license", "flags": "i"}],
28 "binaries-not-present:file-type-exclusion": ["error", {"type": ["**/*.exe", "**/*.dll", "*.o", "*.so"]}],
29 "license-detectable-by-licensee": ["error"],
30 "test-directory-exists:directory-existence": ["error", {"directories": ["test*", "specs"]}],
31 "integrates-with-ci:file-existence": ["warning", {"files": [".gitlab-ci.yml", ".travis.yml", "appveyor.yml", "circle.yml"]}],
32 "source-license-headers-exist:file-starts-with": ["error", {"files": ["*.py"], "lineCount": 30, "patterns": ["Copyright", "The Linux Foundation", "All rights reserved", "SPDX-License-Identifier"]}]
33 },
34 "javascript": {
35 "package-metadata-exists:file-existence": ["error", {"files": ["package.json"]}]
36 },
37 "ruby": {
38 "package-metadata-exists:file-existence": ["error", {"files": ["Gemfile"]}]
39 },
40 "java": {
41 "package-metadata-exists:file-existence": ["error", {"files": ["pom.xml", "build.xml", "build.gradle"]}]
42 },
43 "python": {
44 "package-metadata-exists:file-existence": ["error", {"files": ["requirements.txt", "setup.py"]}]
45 }
46 }
47 }
48 {{/code}}

My Recent Modifications

Need help?

If you need help with XWiki you can contact: