Skip to content

Commit

Permalink
Update CONTRIBUTING.md (#13177)
Browse files Browse the repository at this point in the history
simplified language for clarity
  • Loading branch information
Brad Micklea authored Apr 17, 2019
1 parent e53ce74 commit 6f547cd
Showing 1 changed file with 7 additions and 11 deletions.
18 changes: 7 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
Contributing to Eclipse Che
Filing Issues for Eclipse Che
=====================

Before Submitting an Issue
--------------------------
Check that [our issue database](https://github.com/eclipse/che/issues)
doesn't already include that problem or suggestion before submitting an issue.
If you find a match, you can use the "subscribe" button to get notified on
updates. Do *not* leave random "+1" or "I have this too" comments, as they
only clutter the discussion, and don't help resolving it. However, if you
have ways to reproduce the issue or have additional information that may help
resolving the issue, please leave a comment.
updates. You can leave a Thubms Up reaction to the original issue description to indicate that you have the same problem. Please Do not leave a "+1" or "I have this too" comment unless you are also adding material new information, as they
clutter the discussion.

Writing Good Bug Reports and Feature Requests
---------------------------------------------
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.
Please file a single issue per problem or feature request. Do not file issues that combine problems and feature requests. Please include all the environmental information and reproduction steps so that an engineer can reproduce it.

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.
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. 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.
* The details of your environment including OS version, container configuration, and the steps how you configure & run Che.
* Provide reproducible 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 that show the behavior are often times necessary to observe the problems.
* Animated GIFs are very helpful to show the problems for engineers.
* 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
Expand Down

0 comments on commit 6f547cd

Please sign in to comment.