]> git.r.bdr.sh - rbdr/map/blame - CONTRIBUTING.md
Add code for first release
[rbdr/map] / CONTRIBUTING.md
CommitLineData
5e8ff485
RBR
1# Contributing to Map
2
3Contributions are welcome! If you find this app helpful and would like to
4help, please read on.
5
6## Why does this app exist?
7
8I use wardley maps for many things, and I find that most diagram apps
9are cumbersome to use for this, and pen and paper is hard to share.
10
11I created this app inspired by graphviz, hoping to create a language
12that allows for the easy creation, modification and sharing of wardley maps.
13
14### What kind of contributions are welcome?
15
16Any improvements on the existing features, and bugfixes are welcome.
17
18If you would like to add a new feature, please add an issue
19before submitting code, so we can discuss; also, feel free to fork!
20
21## How to contribute
22
23Above All: Be nice, always.
24
25Befoe opening a merge request:
26
27* Run `make format`
28* Ensure `make lint` shows no warnings or errors
29* Make a merge request describing what/why is included in your changes