summaryrefslogtreecommitdiff
path: root/content/development.md
diff options
context:
space:
mode:
authorLorenzo Torres <torres@sideros.org>2025-03-27 19:45:11 +0100
committerLorenzo Torres <torres@sideros.org>2025-03-27 19:45:11 +0100
commitbef1082673c050eaa3a6b459d1a6d4e2711d859b (patch)
tree08c9a630990abc2f6b8155bb767bd821d3b19b1e /content/development.md
parent40bb66a10bb7b6cbf9dd9d93b054de95cb20eba6 (diff)
base code
Diffstat (limited to 'content/development.md')
-rw-r--r--content/development.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/content/development.md b/content/development.md
new file mode 100644
index 0000000..9b02f7b
--- /dev/null
+++ b/content/development.md
@@ -0,0 +1,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.