1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
| | ---
layout: page
title: Contributing to Spectrum
nav_order: 10
---
<!-- SPDX-FileCopyrightText: 2019-2020, 2022 Alyssa Ross <hi@alyssa.is> -->
<!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later -->
<!-- SPDX-License-Identifier: GPL-3.0-or-later -->
<p>
Thank you so much for your interest in contributing to Spectrum.
Having a healthy community of people who feel empowered to work on the
project is vital to its success. To that end, if you have any
questions about contributing to the project,
please <a href="/doc/contributing/communication.html">get in touch</a>
with the community, and we'll gladly help you out!
<h2>Contributing code</h2>
<p>
If you're interested in contributing code to Spectrum, you
can <a href="https://spectrum-os.org/git/">find</a> the source
repositories online.
If you've made changes you'd like to be included
in the official Spectrum distribution, please send patches to the
spectrum-devel <a href="https://lists.spectrum-os.org/mailman3/lists/devel.spectrum-os.org/">
mailing list</a>
(<a href="mailto:devel@spectrum-os.org">devel@spectrum-os.org</a>).
<p>
<strong>DON'T PANIC.</strong>
<p>
Sending patches to the list is easy — you can do it with Git, straight
from the command line. <strong>You don't have to set anything up in
your email client</strong>, and <strong>you don't have to subscribe to
the list</strong>. The only thing you need to do is probably to set
up Git so it knows how to send email using your provider's SMTP
server. These <a href="https://git-send-email.io/">instructions</a>
should be enough to get you going, but if you're still stuck, send an
email
to <a href="mailto:devel@spectrum-os.org">devel@spectrum-os.org</a>
and we'll help you out.
<p>
Once you have Git configured correctly, sending your changes to the
list should be as simple as something like
<pre>
git send-email origin/master --to devel@spectrum-os.org
</pre>
<p>
You'll be CCed on replies to your posts, so you don't even have to be
subscribed to the mailing list if you're worried about too much
traffic. There's also
a <a href="https://lists.spectrum-os.org/hyperkitty">web interface</a>
that you can use to browse or even post to the mailing list.
<p>
Please add a Signed-off-by line to each patch you submit, to indicate
your certification of
the <a href="https://spectrum-os.org/git/spectrum/tree/DCO-1.1.txt">Developer's
Certificate of Origin</a> for that patch. The easiest way to do this
is with <code>git commit</code>'s <code>-s</code> flag.
<p>
Don't be too afraid of getting it wrong the first couple of times.
This might well be a new way of collaborating for you, and everybody
understands that. Hopefully, you'll soon realise just how effective
this style of collaboration can be compared to the alternatives.
<h2>Contributing other things</h2>
<p>
At this early stage, it's difficult to say what things would be useful
to the project beyond code. Artwork and documentation will be
extremely important and valuable, but we don't yet have a good place
to keep / use them. But, don't let that dissuade you! At some point
we'll need all sorts of things, and we might as well get the work done
early if people are willing to do it.
<p>
If you think you have skills to offer the project beyond writing code,
we'd love to hear from you. The best thing to do is to either talk
with us
on <a href="/doc/contributing/communication.html#spectrum-discuss">spectrum-discuss</a>,
or in real time
on <a href="/doc/contributing/communication.html#chat">Matrix or
IRC</a>.
|