summaryrefslogtreecommitdiff
path: root/contributing.mdwn
blob: 055c9b1fd8b97444b33769623242c17b75bc93d1 (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
[[!meta title="Contributing"]]

We would love for you to contribute to the project. Here are a few
ways you might:

* read this website and documentation for the software: look for
  typos, unclear language, or anything that is unclear or seems wrong,
  and tell us; also tell us if you think something is particularly
  good

* how could the website structure be improved?

* use the software and tell us what you think

If you want to make a change, we love changes in any form that's
convenient for you:

* send us a message explaining the change

* send us a patch to the source code (including website and
  documentation), by email, or a link to a git repository with the
  change, or a pull or merge request on GitHub or GitLab

* send us the modified source file directly

We want it to be easy for you to contribute. How can we make it easier
for you?

# Version control

The primary version control repository is a GitLab:
<https://gitlab.com/subplot/subplot>.

There is an identical copy on Lars's personal git server:
<http://git.liw.fi/subplot/>. You can use either.

# Regular meetings

As a project, we hold [[regular meetings|meetings]], we'd love to see you at one of them.

# Reporting issues

Open issue ticket on the GitLab repository or send us an email.

# Proposing changes

Open a merge request on GitLab or send us a URL we can pull from, or
patches via email.