ecomp-portal-FE/client/bower_components/ui-select/CONTRIBUTING.md

   1 We are excited to have you working on the project and cordially request that you follow the Guidelines:
   2
   3  - [Got a question or problem?](#question)
   4  - [You think you've found a bug?](#bug)
   5  - [Code Style Guidelines](#rules)
   6  - [Commit Message Guidelines](#commit)
   7
   8 ## <a name="question"></a> Got a question or problem?
   9
  10  Firstly, please go over our FAQ: https://github.com/angular-ui/ui-select/wiki/FAQs
  11
  12  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-select) where maintainers are looking at questions tagged with `angular-ui-select`.
  13
  14  StackOverflow is a much better place to ask questions since:
  15  * there are hundreds of people willing to help on StackOverflow
  16  * questions and answers stay available for public viewing so your question / answer might help someone else
  17  * SO voting system assures that the best answers are prominently visible.
  18
  19  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.
  20
  21 ## <a name="bug"></a> You think you've found a bug?
  22
  23  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:
  24  * version of AngularJS used
  25  * version of this library that you are using
  26  * 3rd-party libraries used, if any
  27  * and most importantly - a use-case that fails
  28
  29  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.
  30
  31  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.
  32
  33  The best part is that you don't need to create plunks from scratch - you can use one from our [demo page](http://plnkr.co/edit/a3KlK8dKH3wwiiksDSn2?p=preview).
  34
  35  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.
  36
  37 ## <a name="rules"></a> Coding Rules
  38 To ensure consistency throughout the source code, keep these rules in mind as you are working:
  39
  40 * All features or bug fixes **must pass all tests** (run `gulp` to jshint, build and test).
  41 * All public API methods **must be documented** with ngdoc, an extended version of jsdoc (we added
  42   support for markdown and templating via @ngdoc tag). To see how we document our APIs, please check
  43   out the existing ngdocs and see [this wiki page][ngDocs].
  44
  45 ## <a name="commit"></a> Git Commit Guidelines
  46
  47 We have very precise rules over how our git commit messages can be formatted for maintenance of the changelog and semvar versioning.  This leads to **more
  48 readable messages** that are easy to follow when looking through the **project history**.  But also,
  49 we use the git commit messages to **generate the change log**.
  50
  51 ## Development
  52
  53 ### Prepare your environment
  54 * Install [Node.js](http://nodejs.org/) and NPM (should come with)
  55 * Install global dev dependencies: `npm install -g bower gulp`
  56 * Install local dev dependencies: `npm install && bower install` in repository directory
  57
  58 ### Development Commands
  59
  60 * `gulp` to jshint, build and test
  61 * `gulp build` to jshint and build
  62 * `gulp test` for one-time test with karma (also build and jshint)
  63 * `gulp watch` to watch src files to jshint, build and test when changed
  64
  65 ## Recommended workflow
  66
  67 1. Make changes
  68 2. Run `gulp` or `gulp test` to run Karma tests and ensure they pass.
  69 3. Reset all `dist/*` files
  70 4. Commit changes using the commit message conventions below.
  71 5. Push
  72 6. Create PR
  73
  74 ### Commit Message Format
  75 Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special
  76 format that includes a **type**, a **scope** and a **subject**:
  77
  78 ```
  79 <type>(<scope>): <subject>
  80 <BLANK LINE>
  81 <body>
  82 <BLANK LINE>
  83 <footer>
  84 ```
  85
  86 The **header** is mandatory and the **scope** of the header is optional.
  87
  88 Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
  89 to read on GitHub as well as in various git tools.
  90
  91 ### Revert
  92 If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
  93
  94 ### Type
  95 Must be one of the following:
  96
  97 * **feat**: A new feature
  98 * **fix**: A bug fix
  99 * **docs**: Documentation only changes
 100 * **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
 101   semi-colons, etc)
 102 * **refactor**: A code change that neither fixes a bug nor adds a feature
 103 * **perf**: A code change that improves performance
 104 * **test**: Adding missing tests
 105 * **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
 106   generation
 107
 108 ### Scope
 109 The scope could be anything specifying place of the commit change. For example `$location`,
 110 `$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
 111
 112 ### Subject
 113 The subject contains succinct description of the change:
 114
 115 * use the imperative, present tense: "change" not "changed" nor "changes"
 116 * don't capitalize first letter
 117 * no dot (.) at the end
 118
 119 ### Body
 120 Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
 121 The body should include the motivation for the change and contrast this with previous behavior.
 122
 123 ### Footer
 124 The footer should contain any information about **Breaking Changes** and is also the place to
 125 reference github issues that this commit **Closes**.
 126
 127 **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
 128
 129 #### Examples
 130
 131 Appears under "Features" header, pencil subheader:
 132
 133 ```
 134 feat(pencil): add 'graphiteWidth' option
 135 ```
 136
 137 Appears under "Bug Fixes" header, graphite subheader, with a link to issue #GSNP-28:
 138
 139 ```
 140 fix(graphite): stop graphite breaking when width < 0.1
 141
 142 Closes #123
 143 ```
 144
 145 Appears under "Performance Improvements" header, and under "Breaking Changes" with the breaking change explanation:
 146
 147 ```
 148 perf(pencil): remove graphiteWidth option
 149
 150 BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reason.
 151 ```
 152
 153 The following commit and commit `667ecc1` do not appear in the changelog if they are under the same release. If not, the revert commit appears under the "Reverts" header.
 154
 155 ```
 156 revert: feat(pencil): add 'graphiteWidth' option
 157
 158 This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
 159 ```
 160
 161 A detailed explanation can be found in this [document][https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#].