pulsar/CONTRIBUTING.md

29 lines
1.2 KiB
Markdown
Raw Normal View History

2013-01-31 02:25:36 +04:00
# :rotating_light: Contributing to Atom :rotating_light:
## Issues
* Include screenshots and animated GIFs whenever possible, they are immensely
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
## Code
* Follow the [JavaScript](https://github.com/styleguide/javascript),
[CSS](https://github.com/styleguide/css),
and [Objective-C](https://github.com/github/objective-c-conventions)
styleguides
* Include thoughtfully worded [Jasmine](http://pivotal.github.com/jasmine/)
specs
* Style new elements in both the light and dark default themes when
appropriate
2013-01-31 02:25:36 +04:00
* New packages go in `src/packages/`
2013-06-05 21:51:55 +04:00
* Add 3rd-party packages as a `package.json` dependency
2013-01-31 02:25:36 +04:00
* Commit messages are in the present tense
2013-02-11 21:31:16 +04:00
* Files end with a newline
2013-05-08 22:30:34 +04:00
* 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