summaryrefslogtreecommitdiff
path: root/manual/en/700-contrib.mdwn
blob: dde0db8abe9236e8f9fd9cb8f5ab5b61293dd40a (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
46
47
48
49
50
51
52
Participating in Obnam development
==================================

The Obnam project is quite small, as far as software projects go.
There is one main developer, plus a few others who sometimes help out.
It would be nice to have more people involved, and this chapter is an
introduction for that.

It is a common misunderstanding that only code matters in a software
project. On the contrary, without a number of other things, code is
useless, particularly so in a free software project, including Obnam.
Examples of necessary things in almost any serious software project:

* writing and updating documentation, which includes manuals and
  websites
* translating documentation, and the software's user interface
* providing support to users with questions or problems
* reporting actionable bugs
* processing bug reports: asking for clarifications, reproducing the
  reported problem, finding the cause of the problem, and developing a
  suitable fix
* porting the software to various platforms, including different
  operating systems, different versions of said operating systems,
  different versions of the languages and libraries the software uses,
  different hardware, etc
* quality assurance: developing and performing manual and automated
  tests and benchmarks, and analysing results
* hosting and operating web sites, mailing lists, IRC channels, other
  communication channels
* handling project governance, which includes dealing with conflicts
  between people
* managing the project in general, including making sure things don't
  stall
* finally, writing the code itself, which is a necessary, but not
  sufficient part of having a project that people other than the
  developers can use it

This list is insufficient; additions are welcome. See the rest of this
chapter for suggestions on how to contribute to the list.


Helping support users
---------------------

Writing and updating documentation
----------------------------------

Developing the code
-------------------

Project governance
------------------