]> git.r.bdr.sh - rbdr/map/blame - CONTRIBUTING.md
Address the lint warnings
[rbdr/map] / CONTRIBUTING.md
CommitLineData
5e8ff485
RBR
1# Contributing to Map
2
f93215a7
RBR
3Contributions are welcome (restrictions apply). If you find this app helpful
4and would like to help, please read on.
5e8ff485
RBR
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
f93215a7 14### What kinds of contributions are welcome?
5e8ff485 15
f93215a7 16Bugfixes, performance and code quality improvements are welcome.
5e8ff485 17
f93215a7
RBR
18If you would like to add a new feature or modify existing functionality, please
19send a message before submitting code, so we can discuss.
20
21This is a hobby project of mine, so depending on load it might take a while to
22respond. If this doesn't fit your needs, feel free to fork!
5e8ff485
RBR
23
24## How to contribute
25
26Above All: Be nice, always.
27
5e8ff485 28* Run `make format`
f93215a7 29* Send an email to map@r.bdr.sh with your patch using git send-mail