Creates a nicely formatted Markdown file for reporting an Atom bug and posts the issue to a GitHub repo.
bug-report:open command (Ctrl+Alt+Shift+B by default) and a new Markdown file will be opened with fields for entering description, repro steps and images or movies, plus important diagnostic information to help make great Atom bug reports.
Sample bug report output:
[Enter description here] ![Screenshot or GIF movie](url) ## Repro Steps 1. [First Step] 2. [Second Step] 3. [and so on...] **Expected:** [Enter expected behavior here] **Actual:** [Enter actual behavior here] ## Command History ``` -0:22.6 pane-container:active-pane-item-changed (atom-pane-container.panes) -0:22.6 active-buffer-changed (div.status-bar) -0:22.6 pane:active-item-changed (atom-pane.pane.active.with-minimap) -0:22.6 editor:detached (atom-text-editor.editor.editor-colors) -0:22.6 editor:will-be-removed (atom-text-editor.editor.editor-colors) -0:22.6 pane:item-removed (atom-pane.pane.active.with-minimap) -0:22.5 editor:detached (atom-text-editor.editor.editor-colors) -0:22.5 editor:will-be-removed (atom-text-editor.editor.editor-colors) -0:22.5 minimap:scroll (div.minimap) -0:00.0 bug-report:open (input.hidden-input) ``` ## Versions * **Atom:** 0.153.0-7738472 * **Atom-Shell:** 0.19.4 * **OS:** Mac OS X 10.10.1 * **Misc** * apm 0.111.0 * npm 1.4.4 * node 0.10.33 * python 2.7.6 * git 1.9.3 --- <small>This report was created in and posted from the Atom editor using the package `bug-report` v0.5.3.</small>
When you create a new report, a pane will appear below the editor that enables posting your report as a GitHub Issue.
For the Bug Report package to post on your behalf, you need to supply a GitHub API token. You may obtain one by following the instructions on GitHub. Your token will need at least the
public repo permission for posting to work.
atom/atom. Only post there if you have checked that the problem isn't in a user-supplied package. Do this by running Atom in safe mode with
Post Issue. It should only take a few seconds for Bug Report to post the Issue, after which the panel will show you a link to it.
Once you have posted you will not be able to post this same report again. If you wish, you may copy this report and open a new one to start over.
true— Saves the token in the file specified by
tokenPath. Also uses the token from the file, if it exists.
false— Does not save the token nor does it use it if the file at
tokenPathexists. It will need to be entered each time a report is posted on your behalf.
bug-report.tokenPath— Path at which the API token will be saved to and loaded from if
bug-report:open— Opens the bug report template with version information already included
bug-report:insert-version-info— Inserts the formatted version information into the active text editor
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.