forked from openpnp/openpnp
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
32 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,38 @@ | ||
| # Read This First | ||
| To submit an issue for OpenPnP you must use this template or it will be deleted. Please fill out the appropriate sections below. | ||
| To submit an issue for OpenPnP you must use this template or it will be deleted. Please fill out either the Problem Report or Feature Request section below and delete the other section. | ||
|
|
||
| # Describe the Issue | ||
| > Please describe the issue in as much detail as possible. Without a good description it's impossible for developers to understand the problem. | ||
| # Problem Report | ||
| ## Describe the Issue | ||
| Please describe the issue in as much detail as possible. Without a good description it's impossible for developers to understand the problem. | ||
|
|
||
| # Steps to Reproduce | ||
| > How can a developer reproduce the issue you are experiencing? Use a step by step format like this: | ||
| > 1. Start OpenPnP | ||
| > 2. Click the Power On button. | ||
| > 3. Jog the machine 10mm to the right. | ||
| > 4. The machine fails to jog and shows an error. | ||
| ## Steps to Reproduce | ||
| How can a developer reproduce the issue you are experiencing? Use a step by step format like this: | ||
| 1. Start OpenPnP | ||
| 2. Click the Power On button. | ||
| 3. Jog the machine 10mm to the right. | ||
| 4. The machine fails to jog and shows an error. | ||
|
|
||
| # Expected Result | ||
| > What did you expect to happen? | ||
| ## Expected Result | ||
| What did you expect to happen? Be descriptive. | ||
|
|
||
| # Actual Result | ||
| > What actually happened? Be descriptive. | ||
| ## Actual Result | ||
| What actually happened? Be descriptive. | ||
|
|
||
| # Notes, Log Files, Screen Captures, Videos, etc. to Show the Issue | ||
| > The more information you can provide about the issue the more likely it is that a developer will be able to respond. | ||
| > Whenever possible, please use the Menu -> Help -> Submit Diagnostics feature and include the URL here. | ||
| > Submit Diagnostics makes it easy to include log files, screen capture, debug images, configuration files, etc. | ||
| ## Notes, Log Files, Screen Captures, Videos, etc. to Show the Issue | ||
| The more information you can provide about the issue the more likely it is that a developer will be able to respond. | ||
|
|
||
| Whenever possible, please use the Menu -> Help -> Submit Diagnostics feature and include the URL here. Submit Diagnostics makes it easy to include log files, screen capture, debug images, configuration files, etc. | ||
|
|
||
| # Feature Request | ||
| ## Describe the Feature | ||
| What do you want it to do? Be as descriptive as possible. | ||
|
|
||
| ## How Will It Look? | ||
| If the feature will include changes to the user interface, how would they look? Include drawings or mockups if possible. | ||
|
|
||
| ## Why Do We Need It? | ||
| 1. What problem does it solve? | ||
| 2. Is it useful for everyone, or does it only solve a problem for your machine? | ||
|
|
||
| ## Provide Examples | ||
| Is this something that exists in other pick and place software? Provide examples and references if possible. |