mirror of
				https://github.com/eledio-devices/thirdparty-ArduinoJson.git
				synced 2025-10-31 00:32:37 +01:00 
			
		
		
		
	Update GitHub issue templates
This commit is contained in:
		
							
								
								
									
										14
									
								
								.github/ISSUE_TEMPLATE.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										14
									
								
								.github/ISSUE_TEMPLATE.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,14 +0,0 @@ | ||||
| <!-- | ||||
| Before opening an issue, please read the FAQ: | ||||
| https://arduinojson.org/faq/ | ||||
|  | ||||
| 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! | ||||
| --> | ||||
							
								
								
									
										54
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										54
									
								
								.github/ISSUE_TEMPLATE/bug_report.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,54 @@ | ||||
| --- | ||||
| name: 🐛 Bug report | ||||
| about: Report a bug in ArduinoJson | ||||
| title: '' | ||||
| labels: 'bug' | ||||
| assignees: '' | ||||
| --- | ||||
|  | ||||
| <!-- ⚠️ IMPORTANT ⚠️ | ||||
| Before opening a bug report, please use the ArduinoJson Troubleshooter as it may find a solution to your issue; if not, please include the  Troubleshooter's report in the description. | ||||
| --> | ||||
|  | ||||
| **Describe the bug**   | ||||
| A clear and concise description of what the bug is. | ||||
|  | ||||
| **Troubleshooter report**   | ||||
| Here is the report generated by the [ArduinoJson Troubleshooter](https://arduinojson.org/v6/troubleshooter/):   | ||||
| [Paste the report here] | ||||
|  | ||||
| **Environment**   | ||||
| Here is the environment that I used: | ||||
| * Microcontroller: [e.g. ESP8266] | ||||
| * Core/runtime: [e.g. ESP8266 core for Arduino v3.0.2] | ||||
| * IDE: [e.g. Arduino IDE 1.8.16] | ||||
|  | ||||
| **Reproduction**   | ||||
| Here is a small snippet that reproduces the issue. | ||||
|  | ||||
| ```c++ | ||||
| DynamicJsonDocument doc(1024); | ||||
|  | ||||
| DeserializationError error = deserializeJson(doc, "{\"hello\":\"world\"}"); | ||||
|  | ||||
| [insert repro code here] | ||||
| ``` | ||||
|  | ||||
| **Compiler output**     | ||||
| If relevant, include the complete compiler output (i.e. not just the line that contains the error.) | ||||
|  | ||||
|  | ||||
| **Program output**   | ||||
| If relevant, include the repro program output. | ||||
|  | ||||
| Expected output: | ||||
|  | ||||
| ``` | ||||
| [insert expected output here] | ||||
| ``` | ||||
|  | ||||
| Actual output: | ||||
|  | ||||
| ``` | ||||
| [insert actual output here] | ||||
| ``` | ||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/config.yml
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,8 @@ | ||||
| blank_issues_enabled: true | ||||
| contact_links: | ||||
|   - name: 👨🏫 ArduinoJson Assistant | ||||
|     url: https://arduinojson.org/v6/assistant/ | ||||
|     about: An online tool that computes memory requirements and generates scaffolding code for your project. | ||||
|   - name: 👨⚕️ ArduinoJson Troubleshooter | ||||
|     url: https://arduinojson.org/v6/troubleshooter/ | ||||
|     about: An online tool that helps you diagnose the most common issues with ArduinoJson. | ||||
							
								
								
									
										19
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										19
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,19 @@ | ||||
| --- | ||||
| name: 💡 Feature request | ||||
| about: Suggest an idea for ArduinoJson | ||||
| title: '' | ||||
| labels: enhancement | ||||
| assignees: '' | ||||
| --- | ||||
|  | ||||
| **Is your feature request related to a problem? Please describe.**   | ||||
| A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||||
|  | ||||
| **Describe the solution you'd like**   | ||||
| A clear and concise description of what you want to happen. | ||||
|  | ||||
| **Describe alternatives you've considered**   | ||||
| A clear and concise description of any alternative solutions or features you've considered. | ||||
|  | ||||
| **Additional context**   | ||||
| Add any other context or screenshots about the feature request here. | ||||
							
								
								
									
										51
									
								
								.github/ISSUE_TEMPLATE/help.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										51
									
								
								.github/ISSUE_TEMPLATE/help.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,51 @@ | ||||
| --- | ||||
| name: 😭 Help! | ||||
| about: Ask for help | ||||
| title: '' | ||||
| labels: 'question' | ||||
| assignees: '' | ||||
| --- | ||||
|  | ||||
| <!-- ⚠️ IMPORTANT ⚠️ | ||||
| Before asking for help, please use the ArduinoJson Troubleshooter as it may find a solution to your issue; if not, please include the  Troubleshooter's report in the description. | ||||
| --> | ||||
|  | ||||
| **Describe the issue**   | ||||
| A clear and concise description of what you're trying to do. | ||||
| You don't need to explain every aspect of your project: focus on the problem you're having. | ||||
|  | ||||
| **Troubleshooter report**   | ||||
| Here is the report generated by the [ArduinoJson Troubleshooter](https://arduinojson.org/v6/troubleshooter/):   | ||||
| [Paste the report here] | ||||
|  | ||||
| **Environment**   | ||||
| Here is the environment that I'm using': | ||||
| * Microconroller: [e.g. ESP8266] | ||||
| * Core/runtime: [e.g. ESP8266 core for Arduino v3.0.2] | ||||
| * IDE: [e.g. Arduino IDE 1.8.16] | ||||
|  | ||||
| **Reproduction**   | ||||
| Here is a small snippet that demonstrate the problem. | ||||
|  | ||||
| ```c++ | ||||
| DynamicJsonDocument doc(1024); | ||||
|  | ||||
| DeserializationError error = deserializeJson(doc, "{\"hello\":\"world\"}"); | ||||
|  | ||||
| // insert code here | ||||
| ``` | ||||
|  | ||||
| **Program output**   | ||||
| If relevant, include the program output. | ||||
|  | ||||
| Expected output: | ||||
|  | ||||
| ``` | ||||
| [insert expected output here] | ||||
| ``` | ||||
|  | ||||
| Actual output: | ||||
|  | ||||
| ``` | ||||
| [insert actual output here] | ||||
| ``` | ||||
		Reference in New Issue
	
	Block a user