Skip to content

Commit 21cfc59

Browse files
committed
Document CI-related processes
1 parent 0b97f99 commit 21cfc59

File tree

2 files changed

+47
-6
lines changed

2 files changed

+47
-6
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2025 Friedrich von Never <friedrich@fornever.me>
3+
4+
SPDX-License-Identifier: MIT
5+
-->
6+
7+
Contributor Guide
8+
=================
9+
10+
License Automation
11+
------------------
12+
<!-- REUSE-IgnoreStart -->
13+
If the CI asks you to update the file licenses, follow one of these:
14+
1. Update the headers manually (look at the existing files), something like this:
15+
```
16+
# SPDX-FileCopyrightText: %year% %your name% <%your contact info, e.g. email%>
17+
#
18+
# SPDX-License-Identifier: MIT
19+
```
20+
(accommodate to the file's comment style if required).
21+
2. Alternately, use the [REUSE][reuse] tool:
22+
```console
23+
$ reuse annotate --license MIT --copyright '%your name% <%your contact info, e.g. email%>' %file names to annotate%
24+
```
25+
26+
(Feel free to attribute the changes to "codingteam/devops contributors <https://github.com/codingteam/devops>"
27+
instead of your name in a multi-author file,
28+
or if you don't want your name to be mentioned in the project's source: this doesn't mean you'll lose the copyright.)
29+
<!-- REUSE-IgnoreEnd -->
30+
31+
[reuse]: https://reuse.software/

Readme.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,25 @@ Host specification
2222
- [cthulhu-3][hosts/cthulhu-3]
2323
- [omnissiah][hosts/omnissiah]
2424

25-
[hosts/ctor]: ctor/Host.md
26-
[hosts/cthulhu-3]: cthulhu-3/Host.md
27-
[hosts/omnissiah]: omnissiah/Host.md
28-
[schematic]: docs/devops.png
25+
Documentation
26+
-------------
27+
- [Contributor Guide][docs.contributing]
2928

29+
License
30+
-------
31+
The project is distributed under the terms of [the MIT license][docs.license].
32+
33+
The license indication in the project's sources is compliant with the [REUSE specification v3.3][reuse.spec].
34+
35+
[badge-xmpp.net]: https://xmpp.net/badge.php?domain=codingteam.org.ru
3036
[codingteam.org.ru]: https://codingteam.org.ru
3137
[devops]: https://ru.wikipedia.org/wiki/DevOps
38+
[docs.license]: LICENSES/MIT.txt
39+
[hosts/cthulhu-3]: cthulhu-3/Host.md
40+
[hosts/ctor]: ctor/Host.md
41+
[hosts/omnissiah]: omnissiah/Host.md
3242
[issues]: https://github.com/codingteam/devops/issues
3343
[loglist.xyz]: https://loglist.xyz
44+
[reuse.spec]: https://reuse.software/spec-3.3/
45+
[schematic]: docs/devops.png
3446
[xmpp.net]: https://xmpp.net/result.php?domain=codingteam.org.ru&type=client
35-
36-
[badge-xmpp.net]: https://xmpp.net/badge.php?domain=codingteam.org.ru

0 commit comments

Comments
 (0)