From 15089f0c54fa674e49e24ff7870787d8372119eb Mon Sep 17 00:00:00 2001 From: Cristian Maglie Date: Tue, 12 May 2020 16:26:40 +0200 Subject: [PATCH] Update CONTRIBUTING.md Co-authored-by: per1234 --- CONTRIBUTING.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 54902326e..27e2e104f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,8 +37,18 @@ When you're not sure where your issue belongs, report it at [arduino/Arduino](ht - Search [existing pull requests and issues](https://github.com/arduino/Arduino/issues?q=) to be sure it hasn't already been reported. If you have additional information to provide about an existing issue then please comment on that issue. If you simply want to express your support then use the [Reactions feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). - State the newest version of the Arduino IDE you have verified the issue with and which operating system you are using. - The issue title should be concise yet descriptive. Vague titles make it difficult to know the purpose of the issue when looking through the list of reports and may cause your issue to not be given proper attention. -- Describe the issue and what behavior you were expecting. Post complete error messages using [Markdown code fencing](https://guides.github.com/features/mastering-markdown/#examples) (ex: 3 back-ticks before and after code blocks: \`\`\`my code here\`\`\`). -- Provide a full set of steps necessary to reproduce the issue. Demonstration code should be complete, correct, and simplified to the minimum amount of code necessary to reproduce the issue. Please use [Markdown code fencing](https://guides.github.com/features/mastering-markdown/#examples) (ex: 3 back-ticks before and after code blocks: \`\`\`my code here\`\`\`) when posting code. +- Describe the issue and what behavior you were expecting. Post complete error messages using [Markdown code fencing](https://guides.github.com/features/mastering-markdown/#examples), three backticks before and after the error message: + ```` + ``` + my error message here + ``` + ```` +- Provide a full set of steps necessary to reproduce the issue. Demonstration code should be complete, correct, and simplified to the minimum amount of code necessary to reproduce the issue. Please use [Markdown code fencing](https://guides.github.com/features/mastering-markdown/#examples), three backticks before and after the code: + ```` + ``` + my code here + ``` + ```` - Be responsive. We may need you to provide more information, please respond as soon as possible. - If you find a solution to your problem update your issue report with an explanation of how you were able to fix it and close the issue. - Library Manager submissions: make sure your library meets all the requirements listed in the [Library Manager FAQ](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ).