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://bit.ly/UIR-Plunk) 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 on
|
17 | [StackOverflow](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router) before reporting it. This
|
18 | keeps development streamlined, and helps us focus on building great software.
|
19 |
|
20 |
|
21 | Issues only! |
|
22 | -------------|
|
23 | 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). |
|
24 |
|
25 | ####Purple Labels
|
26 | A purple label means that **you** need to take some further action.
|
27 | - ![Not Actionable - Need Info](ngdoc_assets/incomplete.png): Your issue is not specific enough, or there is no clear action that we can take. Please clarify and refine your issue.
|
28 | - ![Plunkr Please](ngdoc_assets/example.png): Please [create a plunkr](http://bit.ly/UIR-Plunk)
|
29 | - ![StackOverflow](ngdoc_assets/so.png): We suspect your issue is really a help request, or could be answered by the community. Please ask your question on [StackOverflow](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router). If you determine that is an actual issue, please explain why.
|
30 |
|
31 | If your issue gets labeled with purple label, no further action will be taken until you respond to the label appropriately.
|
32 |
|
33 | # Contribute
|
34 |
|
35 | **(1)** See the **[Developing](#developing)** section below, to get the development version of UI-Router up and running on your local machine.
|
36 |
|
37 | **(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.
|
38 |
|
39 | **(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.
|
40 |
|
41 | **(4)** Finally, commit some code and open a pull request. Code & commits should abide by the following rules:
|
42 |
|
43 | - *Always* have test coverage for new features (or regression tests for bug fixes), and *never* break existing tests
|
44 | - Commits should represent one logical change each; if a feature goes through multiple iterations, squash your commits down to one
|
45 | - 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.
|
46 | - Changes should always respect the coding style of the project
|
47 |
|
48 |
|
49 |
|
50 | # Developing
|
51 |
|
52 | UI-Router uses <code>npm</code> and <code>webpack</code>.
|
53 | After cloning the ui-router repository, fetch the dependencies for building from source and running tests:
|
54 |
|
55 | * run `$ npm install` from the project directory
|
56 |
|
57 | There are a number of scripts in the package.json that are used to generate builds and run tests:
|
58 |
|
59 | * `npm test`: runs the entire test suite.
|
60 | * `npm run build`: Perform a full build.
|
61 | * `npm run watch`: Continuously runs the tests when source or tests change.
|