Initial OpenECOMP Portal commit

[portal.git] / ecomp-portal-FE / client / bower_components / ng-dialog / CONTRIBUTING.md

diff --git a/ecomp-portal-FE/client/bower_components/ng-dialog/CONTRIBUTING.md b/ecomp-portal-FE/client/bower_components/ng-dialog/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..3c60d97
--- /dev/null
+++ b/ecomp-portal-FE/client/bower_components/ng-dialog/CONTRIBUTING.md
@@ -0,0 +1,37 @@
+# Testing
+
+ngDialog is in use by many people. In order to ensure quality and prevent regressions, all contributions require unit tests proving that the contribution:
+
+1. Fixes a bug
+2. Performs new functionality as expected
+3. Behaves in a predictable manner when misused (bad input given as an option for example)
+
+In addition, where a contribution is aimed at resolving a bug or implementing a feature that can only be measured in a real browser, an e2e test proving the expected behaviour should be included.
+
+# README
+
+If your PR adds new behaviour or modifies existing behaviour, the README should be updated.
+
+# Coding style
+
+> All code in any code-base should look like a single person typed it, no matter how many people contributed.
+
+This section describes the coding style guide of the repo. You might not agree with it and that's fine, but if you're going to send PRs, treat this guide as a law.
+
+##### There are not too much of rules to follow:
+
+- indent style is 4 spaces
+- always use single quotes
+- one space after `if`, `for`, `while`, etc.
+- no spaces between `(`,`)` and statement content
+- use one `var` per variable unless you don't assign any values to it (and it's short enough)
+- always `'use strict'` mode
+- always use strict comparisons: `===` and `!==`
+- use semicolons
+- don't use comma-first notation
+
+##### These tools will help your IDE to remind you with some of the rules listed above:
+
+- [EditorConfig](http://editorconfig.org)
+- [JSHint](http://jshint.com)
+- [ESLint](http://eslint.org)