| 1 | Contributing
|
| 2 | ============
|
| 3 |
|
| 4 | Questions
|
| 5 | ---------
|
| 6 |
|
| 7 | Please ask support questions on [StackOverflow](http://stackoverflow.com/questions/tagged/webdriver-manager) or [Gitter](https://gitter.im/angular/webdriver-manager).
|
| 8 |
|
| 9 | Any questions posted to webdriver-manager's Github Issues will be closed with this note:
|
| 10 |
|
| 11 | Please direct general support questions like this one to an appropriate support channel, see https://github.com/angular/webdriver-manager/blob/master/CONTRIBUTING.md#questions. Thank you!
|
| 12 |
|
| 13 | Issues
|
| 14 | ======
|
| 15 |
|
| 16 | If you have a bug or feature request, please file an issue. When submitting an issue, please include a reproducible case that we can actually run.
|
| 17 |
|
| 18 | Please format code and markup in your issue using [github markdown](https://help.github.com/articles/github-flavored-markdown).
|
| 19 |
|
| 20 |
|
| 21 | Contributing to Source Code (Pull Requests)
|
| 22 | ===========================================
|
| 23 |
|
| 24 | Loosely, follow the [Angular contribution rules](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md).
|
| 25 |
|
| 26 | * If your PR changes any behavior or fixes an issue, it should have an associated test.
|
| 27 | * New features should be general and as simple as possible.
|
| 28 | * Breaking changes should be avoided if possible.
|
| 29 | * All pull requests require review. No PR will be submitted without a comment from a team member stating LGTM (Looks good to me).
|
| 30 |
|
| 31 | Webdriver-manager specific rules
|
| 32 | -------------------------
|
| 33 |
|
| 34 | * JavaScript style should generally follow the [Google JS style guide](http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml).
|
| 35 | * Wrap code at 100 chars.
|
| 36 | * Document public methods with jsdoc.
|
| 37 | * Be consistent with the code around you!
|
| 38 |
|
| 39 | Commit Messages
|
| 40 | ---------------
|
| 41 |
|
| 42 | Please write meaningful commit messages - they are used to generate the changelog, so the commit message should tell a user everything they need to know about a commit. Webdriver-manager follows AngularJS's [commit message format](https://docs.google.com/a/google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.z8a3t6ehl060).
|
| 43 |
|
| 44 | In summary, this style is
|
| 45 |
|
| 46 | <type>(<scope>): <subject>
|
| 47 | <BLANK LINE>
|
| 48 | <body>
|
| 49 |
|
| 50 | Where `<type>` is one of [feat, fix, docs, refactor, test, chore, deps] and
|
| 51 | `<scope>` is a quick descriptor of the location of the change, such as cli, clientSideScripts, element.
|
| 52 |
|
| 53 | Testing your changes
|
| 54 | --------------------
|
| 55 |
|
| 56 | Test your changes on your machine by running `npm test` to run the test suite.
|
| 57 |
|
| 58 | When you submit a PR, tests will also be run on the Continuous Integration environment
|
| 59 | through Travis. If your tests fail on Travis, take a look at the logs - if the failures
|
| 60 | are known flakes in Internet Explorer or Safari you can ignore them, but otherwise
|
| 61 | Travis should pass.
|