Skip to content
This repository was archived by the owner on Sep 8, 2020. It is now read-only.

Commit 5bec0ae

Browse files
BobbieBarkerSomeKittens
authored andcommitted
docs(contributing): add contributing file
docs(contributing): updated the contributing.md file docs(contributing): forgot the reference bower install in setup docs(contributing): addressed deficiencies in PR
1 parent 4f63fb7 commit 5bec0ae

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

contributing.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
## Got a question or problem?
2+
3+
4+
Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](http://stackoverflow.com/questions/tagged/angular-ui-layout) where maintainers are looking at questions questions tagged with `ui-layout`.
5+
6+
StackOverflow is a much better place to ask questions since:
7+
* there are hundreds of people willing to help on StackOverflow
8+
* questions and answers stay available for public viewing so your question / answer might help someone else
9+
* SO voting system assures that the best answers are prominently visible.
10+
11+
To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
12+
13+
## You think you've found a bug?
14+
15+
We want to fix it ASAP! But before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a _minimal_ reproduce scenario using http://plnkr.co/. Having a live reproduce scenario gives us wealth of important information without going back & forth to you with additional questions like:
16+
17+
* version of AngularJS used
18+
* version of this library that you are using
19+
* 3rd-party libraries used, if any
20+
* and most importantly - a use-case that fails
21+
22+
A minimal reproduce scenario using http://plnkr.co/ allows us to quickly confirm a bug (or point out coding problem) as well as confirm that we are fixing the right problem.
23+
24+
We will be insisting on a minimal reproduce scenario in order to save maintainers time and ultimately be able to fix more bugs. Interestingly, from our experience users often find coding problems themselves while preparing a minimal plunk. We understand that sometimes it might be hard to extract essentials bits of code from a larger code-base but we really need to isolate the problem before we can fix it.
25+
26+
The best part is that you don't need to create plunks from scratch - you can use one from our [demo page](http://angular-ui.github.io/ui-layout/).
27+
28+
Unfortunately we are not able to investigate / fix bugs without a minimal reproduce scenario using http://plnkr.co/, so if we don't hear back from you we are going to close an issue that doesn't have enough info to be reproduced.
29+
30+
31+
## You want to contribute some code?
32+
33+
We are always looking for the quality contributions and will be happy to accept your Pull Requests as long as those adhere to some basic rules:
34+
35+
* Please make sure that your contribution fits well in the project's context:
36+
* There should be no third party dependencies;
37+
* Please assure that you are submitting quality code, specifically make sure that:
38+
* your PR has accompanying tests and all the tests are passing; don't hesitate to contact us ([email protected]) if you need any help with unit testing
39+
* your PR doesn't break the build; check the Travis-CI build status after opening a PR and push corrective commits if anything goes wrong
40+
* your commits conform to the conventions established [here](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md)
41+
42+
43+
# How To Get Started!
44+
45+
## Prepare your enviroment
46+
47+
Setting up the development enviroment for this project couldn't be easier, you'll need to have [Node.js](https://nodejs.org/en/) && NPM installed on your machine.
48+
49+
Once you have NPM installed you'll want to follow these simple steps:
50+
51+
* Fork this projects repository
52+
* Clone it to your local machine
53+
* Install global dev dependencies: `npm install -g gulp karma bower`
54+
* Install local dev dependencies: `npm install` while current directory is ui-layout
55+
* Install bower dependencies: `bower install` while current directory is ui-layout
56+
57+
## Build
58+
59+
* Build the project: `gulp build`
60+
61+
## Run Tests
62+
63+
* Run all tests continously `gulp continuousMode`
64+
* Run all tests once `gulp karma`
65+
* Run all tests and linter once `gulp default`

0 commit comments

Comments
 (0)