From 6df204cf40b335dc8c333e5879c8385088300792 Mon Sep 17 00:00:00 2001 From: Benoit Blanchon Date: Tue, 3 Oct 2017 13:01:47 +0200 Subject: [PATCH] Split CONTRIBUTING and SUPPORT --- .github/CONTRIBUTING.md | 29 ----------------------------- CONTRIBUTING.md | 11 +++++++++++ SUPPORT.md | 27 +++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 29 deletions(-) delete mode 100644 .github/CONTRIBUTING.md create mode 100644 CONTRIBUTING.md create mode 100644 SUPPORT.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md deleted file mode 100644 index a5dbc160..00000000 --- a/.github/CONTRIBUTING.md +++ /dev/null @@ -1,29 +0,0 @@ -# Before asking for assistance - -Before asking for help, please read the [FAQ](https://bblanchon.github.io/ArduinoJson/faq/). - -If you did not find the answer in the FAQ, please create a new issue. - -It is OK to add a comment to a currently opened issue, but please avoid adding comments to a closed issue. - -# Before hitting the Submit button - -Please provide all the relevant information: - -* Good title -* Short description of the problem -* Target platform -* Compiler model and version -* [MVCE](https://stackoverflow.com/help/mcve) -* Compiler output - -Good questions get fast answers! - -# Pull requests - -Please: - -1. Unit test every change in behavior -2. Use clang-format in "file" mode to format the code -3. Consider using the Continuous Integration (Travis and AppVeyor) - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5d4b96cf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +# Contribution to ArduinoJson + +First, thank you for taking the time to contribute to this project. + +You can submit changes via GitHub Pull Requests. + +Please: + +1. Unit test every change in behavior +2. Use clang-format in "file" mode to format the code +3. Consider using the Continuous Integration (Travis and AppVeyor) diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 00000000..6c6b3c92 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,27 @@ +# ArduinoJson Support + +First off, thank you very much for using ArduinoJson. + +We'll be very happy to help you, but first please read the following. + +## Before asking for help + +1. Read the [FAQ](https://bblanchon.github.io/ArduinoJson/faq/) +2. Search in the [API Reference](https://bblanchon.github.io/ArduinoJson/api/) + +If you did not find the answer, please create a [new issue on GitHub](https://github.com/bblanchon/ArduinoJson/issues/new). + +It is OK to add a comment to a currently opened issue, but please avoid adding comments to a closed issue. + +## Before hitting the Submit button + +Please provide all the relevant information: + +* Good title +* Short description of the problem +* Target platform +* Compiler model and version +* [MVCE](https://stackoverflow.com/help/mcve) +* Compiler output + +Good questions get fast answers!