[rbdr/map] / CONTRIBUTING.md

# 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
Commit	Line	Data
5e8ff485 RBR	1	# Contributing to Map
	2
	3	Contributions are welcome! If you find this app helpful and would like to
	4	help, please read on.
	5
	6	## Why does this app exist?
	7
	8	I use wardley maps for many things, and I find that most diagram apps
	9	are cumbersome to use for this, and pen and paper is hard to share.
	10
	11	I created this app inspired by graphviz, hoping to create a language
	12	that allows for the easy creation, modification and sharing of wardley maps.
	13
	14	### What kind of contributions are welcome?
	15
	16	Any improvements on the existing features, and bugfixes are welcome.
	17
	18	If you would like to add a new feature, please add an issue
	19	before submitting code, so we can discuss; also, feel free to fork!
	20
	21	## How to contribute
	22
	23	Above All: Be nice, always.
	24
	25	Befoe 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