The people involved in Atom (both GitHub employees and volunteers) want it to be the best it possibly can be. Nobody wants to be bombarded with a thousand questions just to get something fixed, so it is good to include the following information at a bare minimum (the more information you can include, the better):
- Version of Atom you encountered the bug in
- OS and version you’re on
- Steps to reproduce the problem
- What you expected to happen
- What actually happened
Also see the Atom Contributing Guide and this blog post for more suggestions.
Here’s an example from a bug about opening files at specific line numbers:
Reproduced using Atom v0.211.0-fc4f2a1 on Mac OS X 10.10.3.
Steps to Reproduce
- Change directory to
$HOME
- Execute
mkdir temp
- Execute
touch temp/file.tex
-
Works as expected: Start Atom with
atom temp/file.tex:100
- Close Atom with Cmd+Q
- Change directory to
$HOME/temp
- Start Atom with
atom file.tex:100
Expected: Atom opens with the file.tex
file already open
Actual: Atom opens with a new file called file.tex:100
already open