Update CONTRIBUTING.md
parent
e316ba7945
commit
f277610f4b
|
|
@ -13,14 +13,19 @@ resolving the issue, please leave a comment.
|
|||
|
||||
Writing Good Bug Reports and Feature Requests
|
||||
---------------------------------------------
|
||||
Please file a single issue per problem and feature request. Do not file combo issues.
|
||||
Please file a single issue per problem and feature request. Do not file combo issues. Please do not submit multiple comments on a single issue - write your issue with all the environmental information and reproduction steps so that an engineer can reproduce it.
|
||||
|
||||
The more information you can provide, the more likley someone will be successful reproducing the issue and finding a fix. Therefore:
|
||||
The community wants to help you find a solution to your problem, but every problem is unique. In order for an engineer to help resolve your issue, they need to be able to reproduce it. We put the product through extensive manual and automated QA for every release, and verify all of its functionality. Any feature that was previously working in a release that is no longer working is marked as a severity/blocker for immediate review.
|
||||
|
||||
This means that if you are encountering an error, it is likely due to a unique configuration of your system. Reproducing your specific error may require significant information about your system and environment. Help us in advance by providing a complete assessment of your system and the steps necessary to reproduce the issue.
|
||||
|
||||
Therefore:
|
||||
* The details of your environment including OS version, Docker configuration, and the steps how you configure & run Che.
|
||||
* Provide reproducibule steps, what the result of the steps was, and what you would have expected.
|
||||
* When providing reproduction steps, start with launching Che providing its configuration and every step taken to create the problem.
|
||||
* A detailed description of the behavior that you expect.
|
||||
* Animated GIFs are a tremendous help.
|
||||
* Version information of Eclipse Che and Docker.
|
||||
* Error outputs that may exist in your browser console.
|
||||
* Animated GIFs that show the behavior are often times necessary to observe the problems.
|
||||
* If there are UI issues or errors, please run the steps with the browser dev console open and send those logs with your report.
|
||||
|
||||
Contributing Improvements
|
||||
-------------------------
|
||||
|
|
|
|||
Loading…
Reference in New Issue