|
| 1 | +## Got a question or problem? |
| 2 | + |
| 3 | +Firstly, please go over our FAQ: https://github.com/ziscloud/angular-bootstrap-toggle/wiki/FAQ |
| 4 | + |
| 5 | +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-bootstrap-toggle) where maintainers are looking at questions questions tagged with `angular-bootstrap-toggle`. |
| 6 | + |
| 7 | +StackOverflow is a much better place to ask questions since: |
| 8 | +* there are hundreds of people willing to help on StackOverflow |
| 9 | +* questions and answers stay available for public viewing so your question / answer might help someone else |
| 10 | +* SO voting system assures that the best answers are prominently visible. |
| 11 | + |
| 12 | +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. |
| 13 | + |
| 14 | +## You think you've found a bug? |
| 15 | + |
| 16 | +Oh, we are ashamed and 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: |
| 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://ziscloud.github.io/angular-bootstrap-toggle/). |
| 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 don't have enough info to be reproduced. |
| 29 | + |
| 30 | + |
| 31 | +## You want to contribute some code? |
| 32 | + |
| 33 | +**NOTE: We are migrating all our components to use a prefix, in the meantime you will see both the new and the old directives separated by a comment. If you want to contribute with code, make all your changes on top of that comment.** |
| 34 | + |
| 35 | +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: |
| 36 | + |
| 37 | +* Please make sure that your contribution fits well in the project's context: |
| 38 | + * we are aiming at rebuilding bootstrap directives in pure AngularJS, without any dependencies on any external JavaScript library; |
| 39 | + * the only dependency should be bootstrap CSS and its markup structure; |
| 40 | + * directives should be html-agnostic as much as possible which in practice means: |
| 41 | + * templates should be referred to using the `templateUrl` property |
| 42 | + * it should be easy to change a default template to a custom one |
| 43 | + * directives shouldn't manipulate DOM structure directly (when possible) |
| 44 | +* Please assure that you are submitting quality code, specifically make sure that: |
| 45 | + * your directive has accompanying tests and all the tests are passing |
| 46 | + * 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 |
| 47 | + * your commits conform to the conventions established [here](https://github.com/ajoslin/conventional-changelog/blob/master/conventions/angular.md) |
0 commit comments