Skip to content

Commit 4a15538

Browse files
Update CONTRIBUTING.md
1 parent 50e30e5 commit 4a15538

File tree

1 file changed

+16
-25
lines changed

1 file changed

+16
-25
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,33 @@
22
# Report an Issue
33

44
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)
5+
it hasn't already been reported. You can [search through existing ui-router-ng2 issues](https://github.com/ui-router/ng2?search?q=wat%3F&type=Issues) and [ui-router-core issues](https://github.com/ui-router/core?search?q=wat%3F&type=Issues)
66
to see if someone's reported one similar to yours.
77

88
If not, then [create a plunkr](http://bit.ly/UIR-Plunk) that demonstrates the problem (try to use as little code
99
as possible: the more minimalist, the faster we can debug it).
1010

11-
Next, [create a new issue](https://github.com/angular-ui/ui-router/issues/new) that briefly explains the problem,
11+
Next, [create a new issue](https://github.com/ui-router/ng2/issues/new) that briefly explains the problem,
1212
and provides a bit of background as to the circumstances that triggered it. Don't forget to include the link to
1313
that plunkr you created!
1414

1515
**Note**: If you're unsure how a feature is used, or are encountering some unexpected behavior that you aren't sure
1616
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
17+
[StackOverflow](http://stackoverflow.com/questions/ask?tags=angular2,ui-router-ng2) before reporting it. This
1818
keeps development streamlined, and helps us focus on building great software.
1919

2020

2121
Issues only! |
2222
-------------|
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.
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, use StackOverflow. |
3224

3325
# Contribute
3426

3527
**(1)** See the **[Developing](#developing)** section below, to get the development version of UI-Router up and running on your local machine.
3628

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.
29+
**(2)** Check out the [roadmap](https://github.com/ui-router/ng2/milestones) to see where the project is headed, and if your feature idea fits with where we're headed.
3830

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.
31+
**(3)** If you're not sure, [open an RFC](https://github.com/ui-router/ng2/issues/new?title=RFC:%20My%20idea) to get some feedback on your idea.
4032

4133
**(4)** Finally, commit some code and open a pull request. Code & commits should abide by the following rules:
4234

@@ -56,50 +48,49 @@ UI-Router uses <code>npm</code> and <code>webpack</code>.
5648
The code for Angular UI-Router is split into two source repositories:
5749

5850
* [UI-Router Core](https://github.com/ui-router/core) (`ui-router-core` on npm)
59-
* [UI-Router for Angular 1](https://github.com/angular-ui/ui-router) (`angular-ui-router` on npm)
51+
* [UI-Router for Angular 2](https://github.com/ui-router/ng2) (`ui-router-ng2` on npm)
6052

6153
Clone both repositories into directories next to each other.
6254

6355
```
64-
git clone https://github.com/angular-ui/ui-router.git angular-ui-router
56+
git clone https://github.com/ui-router/ng2.git angular-ui-router
6557
git clone https://github.com/ui-router/core.git ui-router-core
6658
```
6759

6860
## Install dependencies
6961

70-
Use `npm` to install the development dependencies for each repositor.
62+
Use `npm` to install the development dependencies for each repository.
7163

7264
```
7365
cd ui-router-core
7466
npm install
75-
cd ../angular-ui-router
67+
cd ../ui-router-ng2
7668
npm install
7769
cd ..
7870
```
7971

8072
## Link the directories
8173

8274
This step is necessary if you need to modify any code in `ui-router-core`.
83-
Using `npm`, link `ui-router-core` into `angular-ui-router`
75+
Using `npm`, link `ui-router-core` into `ui-router-ng2`
8476

8577
```
8678
cd ui-router-core
8779
npm link
88-
cd ../angular-ui-router
80+
cd ../ui-router-ng2
8981
npm link ui-router-core
9082
cd ..
9183
```
9284

93-
After executing these steps, `angular-ui-router` will be built using your local copy of `ui-router-core`.
85+
After executing these steps, `ui-router-ng2` will be built using your local copy of `ui-router-core`.
9486

9587
## Develop
9688

9789
* `npm run build`: Perform a full build.
98-
* `npm test`: Runs the `angular-ui-router` test suite (against Angular 1.2 through 1.5).
99-
* `npm run watch`: Continuously runs the tests when source or tests change.
90+
* `npm run watch`: Continuously builds and runs tests when source or tests change.
10091

101-
If you make changes in `ui-router-core`, run these scripts before rebuilding or re-testing `angular-ui-router`:
92+
If you make changes in `ui-router-core`, run these scripts before rebuilding or re-testing `ui-router-ng2`:
10293

10394
* `npm run build`: Compiles `ui-router-core` code
104-
* `npm test`: Runs the `ui-router-core` test suite
95+
* `npm run watch`: Continuously builds the `ui-router-core` code when sources change.
10596

0 commit comments

Comments
 (0)