|
| 1 | + |
| 2 | +## Report an Issue |
| 3 | + |
| 4 | +Help us make UI-Router better! If you think you might have found a bug, or some other weirdness, start by making sure |
| 5 | +it hasn't already been reported. You can [search through existing issues](https://github.com/angular-ui/ui-router/search?q=wat%3F&type=Issues) |
| 6 | +to see if someone's reported one similar to yours. |
| 7 | + |
| 8 | +If not, then [create a plunkr](http://plnkr.co/edit/u18KQc?p=preview) that demonstrates the problem (try to use as little code |
| 9 | +as possible: the more minimalist, the faster we can debug it). |
| 10 | + |
| 11 | +Next, [create a new issue](https://github.com/angular-ui/ui-router/issues/new) that briefly explains the problem, |
| 12 | +and provides a bit of background as to the circumstances that triggered it. Don't forget to include the link to |
| 13 | +that plunkr you created! |
| 14 | + |
| 15 | +**Note**: If you're unsure how a feature is used, or are encountering some unexpected behavior that you aren't sure |
| 16 | +is a bug, it's best to talk it out in the |
| 17 | +[Google Group](https://groups.google.com/forum/#!categories/angular-ui/router) or on |
| 18 | +[StackOverflow](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router) before reporting it. This |
| 19 | +keeps development streamlined, and helps us focus on building great software. |
| 20 | + |
| 21 | +Please keep in mind that the issue tracker is for *issues*. Please do *not* post an issue if you need help or support. Instead, see one of the above-mentioned forums or [IRC](irc://irc.freenode.net/#angularjs). |
| 22 | + |
| 23 | + |
| 24 | +## Contribute |
| 25 | + |
| 26 | +**(1)** See the **[Developing](#developing)** section below, to get the development version of UI-Router up and running on your local machine. |
| 27 | + |
| 28 | +**(2)** Check out the [roadmap](https://github.com/angular-ui/ui-router/milestones) to see where the project is headed, and if your feature idea fits with where we're headed. |
| 29 | + |
| 30 | +**(3)** If you're not sure, [open an RFC](https://github.com/angular-ui/ui-router/issues/new?title=RFC:%20My%20idea) to get some feedback on your idea. |
| 31 | + |
| 32 | +**(4)** Finally, commit some code and open a pull request. Code & commits should abide by the following rules: |
| 33 | + |
| 34 | +- *Always* have test coverage for new features (or regression tests for bug fixes), and *never* break existing tests |
| 35 | +- Commits should represent one logical change each; if a feature goes through multiple iterations, squash your commits down to one |
| 36 | +- Make sure to follow the [Angular commit message format](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format) so your change will appear in the changelog of the next release. |
| 37 | +- Changes should always respect the coding style of the project |
| 38 | + |
| 39 | + |
| 40 | + |
| 41 | +## Developing |
| 42 | + |
| 43 | +UI-Router uses <code>grunt >= 0.4.x</code>. Make sure to upgrade your environment and read the |
| 44 | +[Migration Guide](http://gruntjs.com/upgrading-from-0.3-to-0.4). |
| 45 | + |
| 46 | +Dependencies for building from source and running tests: |
| 47 | + |
| 48 | +* [grunt-cli](https://github.com/gruntjs/grunt-cli) - run: `$ npm install -g grunt-cli` |
| 49 | +* Then, install the development dependencies by running `$ npm install` from the project directory |
| 50 | + |
| 51 | +There are a number of targets in the gruntfile that are used to generating different builds: |
| 52 | + |
| 53 | +* `grunt`: Perform a normal build, runs jshint and karma tests |
| 54 | +* `grunt build`: Perform a normal build |
| 55 | +* `grunt dist`: Perform a clean build and generate documentation |
| 56 | +* `grunt dev`: Run dev server (sample app) and watch for changes, builds and runs karma tests on changes. |
0 commit comments