Create CONTRIBUTING.md

This commit is contained in:
Glavin Wiechert 2015-08-17 21:11:21 -03:00
parent d8b1976dbc
commit 1049a7311c
1 changed files with 18 additions and 0 deletions

18
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,18 @@
# Contributing
## New Issues, Bugs, Questions, etc
Before creating any new Issues, please be sure to search through the existing Atom Beautify Issues at https://github.com/Glavin001/atom-beautify/issues
1. Generate your debugging information:
1a. In the Atom [command-palette](https://atom.io/packages/command-palette),
search for and run the command `Atom Beautify: Help Debug Editor`.
The debugging results will be copied to your clipboard.
1b. Create a new Gist at https://gist.github.com/
1c. Create a file in your new Gist called `debug.md`.
1d. Paste your debugging results from Atom beautify into `debug.md` file in your Gist.
2. Create a [new GitHub Issue for Atom Beautify](https://github.com/Glavin001/atom-beautify/issues/new).
3. Copy a link to your new Gist into the new GitHub Issue for Atom Beautify.
4. Describe your issue / bug.
5. Submit your new GitHub Issue and wait patiently.
If you have any additional / new information to add, please feel free to comment on that Issue and provide more helpful information.