Skip to content

Commit 6940dec

Browse files
Link to CONTRIBUTING.md
Link to CONTRIBUTING.md, instead of duplicating it.
1 parent 858e0ad commit 6940dec

File tree

1 file changed

+2
-52
lines changed

1 file changed

+2
-52
lines changed

README.md

+2-52
Original file line numberDiff line numberDiff line change
@@ -236,58 +236,8 @@ myApp.config(function($stateProvider) {
236236
* [Activating States](https://egghead.io/lessons/angularjs-ui-router-activating-states) (egghead.io)
237237
* [Learn Angular.js using UI-Router](http://youtu.be/QETUuZ27N0w) (LearnCode.academy)
238238

239-
## Report an Issue
240239

241-
Help us make UI-Router better! If you think you might have found a bug, or some other weirdness, start by making sure
242-
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)
243-
to see if someone's reported one similar to yours.
244240

245-
If not, then [create a plunkr](http://plnkr.co/edit/u18KQc?p=preview) that demonstrates the problem (try to use as little code
246-
as possible: the more minimalist, the faster we can debug it).
241+
## Reporting issues and Contributing
247242

248-
Next, [create a new issue](https://github.com/angular-ui/ui-router/issues/new) that briefly explains the problem,
249-
and provides a bit of background as to the circumstances that triggered it. Don't forget to include the link to
250-
that plunkr you created!
251-
252-
**Note**: If you're unsure how a feature is used, or are encountering some unexpected behavior that you aren't sure
253-
is a bug, it's best to talk it out in the
254-
[Google Group](https://groups.google.com/forum/#!categories/angular-ui/router) or on
255-
[StackOverflow](http://stackoverflow.com/questions/ask?tags=angularjs,angular-ui-router) before reporting it. This
256-
keeps development streamlined, and helps us focus on building great software.
257-
258-
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).
259-
260-
261-
## Contribute
262-
263-
**(1)** See the **[Developing](#developing)** section below, to get the development version of UI-Router up and running on your local machine.
264-
265-
**(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.
266-
267-
**(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.
268-
269-
**(4)** Finally, commit some code and open a pull request. Code & commits should abide by the following rules:
270-
271-
- *Always* have test coverage for new features (or regression tests for bug fixes), and *never* break existing tests
272-
- Commits should represent one logical change each; if a feature goes through multiple iterations, squash your commits down to one
273-
- 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.
274-
- Changes should always respect the coding style of the project
275-
276-
277-
278-
## Developing
279-
280-
UI-Router uses <code>grunt >= 0.4.x</code>. Make sure to upgrade your environment and read the
281-
[Migration Guide](http://gruntjs.com/upgrading-from-0.3-to-0.4).
282-
283-
Dependencies for building from source and running tests:
284-
285-
* [grunt-cli](https://github.com/gruntjs/grunt-cli) - run: `$ npm install -g grunt-cli`
286-
* Then, install the development dependencies by running `$ npm install` from the project directory
287-
288-
There are a number of targets in the gruntfile that are used to generating different builds:
289-
290-
* `grunt`: Perform a normal build, runs jshint and karma tests
291-
* `grunt build`: Perform a normal build
292-
* `grunt dist`: Perform a clean build and generate documentation
293-
* `grunt dev`: Run dev server (sample app) and watch for changes, builds and runs karma tests on changes.
243+
Please read our [Contributor guidelines](CONTRIBUTING.md) before reporting an issue or creating a pull request.

0 commit comments

Comments
 (0)