From: Ruben Beltran del Rio Date: Mon, 16 Sep 2024 10:45:43 +0000 (+0200) Subject: Update contributing X-Git-Url: https://git.r.bdr.sh/rbdr/map/commitdiff_plain/f93215a7b37e065a0a52a852bb2c35d2a3d77b0b Update contributing --- 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