diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a334b694..09ac1812e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,34 +3,31 @@ ## Issues * Include screenshots and animated GIFs whenever possible, they are immensely - helpful + helpful. * Include the behavior you expected to happen and other places you've seen that behavior such as Emacs, vi, Xcode, etc. - * Check the Console app for stack traces to include if reporting a crash - * Check the Dev tools (`alt-cmd-i`) for errors and stack traces to include + * Check the Console app for stack traces to include if reporting a crash. + * Check the Dev tools (`alt-cmd-i`) for errors and stack traces to include. -## Code +## Pull Requests + * Include screenshots and animated GIFs whenever possible. * Follow the [JavaScript](https://github.com/styleguide/javascript) and [CSS](https://github.com/styleguide/css) styleguides * Include thoughtfully worded [Jasmine](http://pivotal.github.com/jasmine/) specs - * Add 3rd-party packages as a `package.json` dependency + * Avoid placing files in `vendor`. 3rd-party packages should be added as a + `package.json` dependency. * Commit messages are in the present tense - * Commit messages that improve the format of the code start with :lipstick: - * Commit messages that improve the performance start with :racehorse: - * Commit messages that remove memory leaks start with :non-potable_water: - * Commit messages that improve documentation start with :memo: - * Files end with a newline + * Files end with a newline. + * Requires should be in the following order: + * Built in Atom and Atom Shell modules + * Node Modules + * Local Modules (using relative links) * Class variables and methods should be in the following order: - * Class variables (variables starting with a `@`) * Class methods (methods starting with a `@`) - * Instance variables * Instance methods * Beware of platform differences - * The home directory is `process.env.USERPROFILE` on Windows, while on OS X - and Linux it's `process.env.HOME` - * Path separator is `\` on Windows, and is `/` on OS X and Linux, so use - `path.join` to concatenate filenames + * Use `fs.getHomeDirectory()` to get home directory. + * Use `path.join()` to concatenate filenames. * Temporary directory is not `/tmp` on Windows, use `os.tmpdir()` when possible -