summaryrefslogtreecommitdiff
path: root/content/development.md
blob: 9b02f7baa258ce93d7162f72469a67446627d94b (plain)
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
<!-- title: Development -->

# Development

Sideros development is email-driven, as contributions, discussions and logs all take place on specific automated mailing lists.

## Mailing lists

Mailing lists are automated, to subscribe just send an email to
```
list-name at lists.sideros.org
```
putting `subscribe` in the mail body.
Please note that some clients usually send emails with html by default, you should ensure to send plain-text emails instead, otherwise commands will not be parsed correctly.


Here is a list of the development related mailing lists:

<table>
<th>List name</th>
<th>Description</th>
<tr>
<td>patch</td>
<td>Send git patch files, see <a href="#Contributing">Contributing</a> for more info.</td>
</tr>
<tr>
<td>git</td>
<td>(Read-only) commit logs are automatically sent here.</td>
</tr>
</table>

## Contributing

Documentation for contributors is available in the source tree, under the [`documentation/`](https://git.sideros.org/sideros/tree/documentation) directory. Once you got a modification you want to send, create a commit using git and generate a patch file with the following command:
```
$ git format-patch -M origin/master
```
and when you have the patch file send it to the `patch` mailing list, possibly using `git send-email` like this:
```
$ git send-email *.patch
```

## Bugs

We use [Bugzilla](https://bugs.sideros.org) to track issues and feature requests. You can create an account there and subscribe to specific bugs to get emails with updates.