aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
blob: 5e112f753390d12e0c22d69d8bdf78837ef8ed94 (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! 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 kind of contributions are welcome?

Any improvements on the existing features, and bugfixes are welcome.

If you would like to add a new feature, please add an issue
before submitting code, so we can discuss; also, feel free to fork!

## How to contribute

Above All: Be nice, always.

Befoe opening a merge request:

* Run `make format`
* Ensure `make lint` shows no warnings or errors
* Make a merge request describing what/why is included in your changes