aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorRuben Beltran del Rio <git@r.bdr.sh>2024-09-16 12:45:43 +0200
committerRuben Beltran del Rio <git@r.bdr.sh>2024-09-16 12:45:43 +0200
commitf93215a7b37e065a0a52a852bb2c35d2a3d77b0b (patch)
tree729525fa28f53aba640de64f21743b0a249887cd /CONTRIBUTING.md
parent8a50aceaf20dd2e9c06b278c8b252ebee91b6174 (diff)
Update contributing
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5e112f7..45fc8a2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,7 +1,7 @@
# Contributing to Map
-Contributions are welcome! If you find this app helpful and would like to
-help, please read on.
+Contributions are welcome (restrictions apply). If you find this app helpful
+and would like to help, please read on.
## Why does this app exist?
@@ -11,19 +11,19 @@ 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?
+### What kinds of contributions are welcome?
-Any improvements on the existing features, and bugfixes are welcome.
+Bugfixes, performance and code quality improvements 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!
+If you would like to add a new feature or modify existing functionality, please
+send a message before submitting code, so we can discuss.
+
+This is a hobby project of mine, so depending on load it might take a while to
+respond. If this doesn't fit your needs, 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
+* Send an email to map@r.bdr.sh with your patch using git send-mail