git.r.bdr.sh - rbdr/map/blob - CONTRIBUTING.md

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