From 41e93968d552504ac39f97081829d7cb957368f0 Mon Sep 17 00:00:00 2001 From: Strahinja Jacimovic Date: Mon, 19 Apr 2021 10:48:40 +0200 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9f4871f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to mikroSDK Coding Rules repository + +--- + +Welcome, and thank you for showing interest in contributing to MikroElektronika's mikroSDK Coding Rules! + +There are many ways in which you can contribute. The goal of this document is to provide a high-level overview of how you can get involved. + +## Suggest new rules + +If you have any suggestions, feel free to create an issue for it. + +Make sure to explain why the coding rule is a good idea and how it benefits the whole code to deployment process. + +## Suggest existing rule modification + +Don't like an existing rule? Create an issue explaining why. + +Make sure to explain why the coding rule change is a good idea and how it benefits the whole code to deployment process. + +## Suggest rule removal + +Rule removal is possible. However, take into consideration that a poll shall be created where all current users and collaborators/contributors +can share their thought and/or approve current rule removal motion. + +## Thank You + +Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.