bblanchon/ArduinoJson
1
0
Fork 1
mirror of https://github.com/bblanchon/ArduinoJson.git synced 2025-07-29 18:27:37 +02:00
Code Issues Packages Projects Releases Wiki Activity

Split CONTRIBUTING and SUPPORT

Browse Source
This commit is contained in:
Benoit Blanchon
2017-10-03 13:01:47 +02:00
parent 3f7e1db549
commit 6df204cf40
3 changed files with 38 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
.github/CONTRIBUTING.md vendored
View File

@ -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)

11
CONTRIBUTING.md Normal file
View File

@ -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)

27
SUPPORT.md Normal file
View File

@ -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!