aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 45fc8a2114f31c6653b22ef25599135edf5f347f (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
# Contributing to Map

Contributions are welcome (restrictions apply). If you find this app helpful
and would like to help, please read on.

## Why does this app exist?

I use wardley maps for many things, and I find that most diagram apps
are cumbersome to use for this, and pen and paper is hard to share.

I created this app inspired by graphviz, hoping to create a language
that allows for the easy creation, modification and sharing of wardley maps.

### What kinds of contributions are welcome?

Bugfixes, performance and code quality improvements are welcome.

If you would like to add a new feature or modify existing functionality, please
send a message before submitting code, so we can discuss.

This is a hobby project of mine, so depending on load it might take a while to
respond. If this doesn't fit your needs, feel free to fork!

## How to contribute

Above All: Be nice, always.

* Run `make format`
* Send an email to map@r.bdr.sh with your patch using git send-mail