Resolve VC-171 "Update contributing related files"

Slava V · pavelthq · commit a1d941b3c6a1 · 2019-02-28T14:48:45.000Z
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+reported by contacting the project team at [hello@visualcomposer.com](mailto:hello@visualcomposer.com). All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,55 +1,36 @@
 # Contributing to Visual Composer Website Builder
+You can contribute and help make Visual Composer better. Follow the guidelines:
+ - [Code of Conduct](#code-of-conduct)
+ - [Submission Guidelines](#submission-guidelines)
+ - [Coding Rules](#coding-rules)
+ - [Installation instruction](#installation-instruction)
 
-## Branch Organization
-We will do our best to keep the **master** branch in good shape, with tests passing at all times.
+## Code of Conduct
+Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
 
-If you send a pull request, please do it against the master branch. We maintain stable branches for major versions separately but we don’t accept pull requests to them directly. Instead, we cherry-pick non-breaking changes from master to the latest stable major version.
+## Submission Guidelines
 
-## Semantic Versioning
-Visual Composer follows semantic versioning. We release patch versions for bugfixes, minor versions for new features, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.
+### Forking workflow
+Keep the `master` branch tests passing at all times.
 
-Every significant change is documented in the changelog file.
+If you send a pull request, please do it against the master branch. We maintain stable branches for major versions separately (Example: `12.x`). Instead of accepting pull requests to the version branches directly, we cherry-pick non-breaking changes from `master` to the version.
 
-
-## From Mainline to Forking workflow
-
-Make fork for of VCWB repo in Gitlab.
-
-To setup repo with SSH from the scratch
-
-Go to your active Wordpress wp-plugin directory
+Make fork for of VCWB repo in GitHub. Go to your active WordPress `wp-content/plugins` directory.
 
 ```sh
-$ git clone git@gitlab.com:<Username>/builder.git
+$ git clone git@github.com:<Username>/builder.git
 $ cd builder
-$ git remote add upstream git@gitlab.com:visual-composer-website-builder/builder.git
+$ git remote add upstream git@gihub.com:Visualcomposer/builder.git
 $ git remote set-url --push upstream no_push
 $ git remote -v
-origin	git@gitlab.com:<Username>/builder.git (fetch)
-origin	git@gitlab.com:<Username>/builder.git (push)
-upstream	git@gitlab.com:visual-composer-website-builder/builder.git (fetch)
-upstream	no_push (push)
-```
-
-If you already have repo just follow the instructions
-
-```sh
-$ git remote rename origin upstream
-$ git remote add origin git@gitlab.com:<Username>/builder.git
-$ git push -u origin master
-$ git remote set-url --push upstream no_push
-$ git remote -v
-origin	git@gitlab.com:<Username>/builder.git (fetch)
-origin	git@gitlab.com:<Username>/builder.git (push)
-upstream	git@gitlab.com:visual-composer-website-builder/builder.git (fetch)
+origin	git@github.com:<Username>/builder.git (fetch)
+origin	git@github.com:<Username>/builder.git (push)
+upstream	git@github.com:Visualcomposer/builder.git (fetch)
 upstream	no_push (push)
 ```
 
 ### Creating features
-
-Use Feature Branch workflow
-
-If you want to send you data to upstream you need to create merge request in Gitlab
+Use [Feature Branch workflow](https://es.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow). If you want to send you data to upstream you need to [create pull request in GitHub](https://help.github.com/en/articles/creating-a-pull-request-from-a-fork).
 
 ```sh
 $ git checkout -b <VC-ID-feature-branch-in-kebab-case>
@@ -59,15 +40,113 @@ $ git push -u origin <feature-branch-in-kebab-case>
 ```
 
 ### Bring builder up to date
-
 ```sh
 $ git checkout master && git pull upstream master # checkout
 $ git push
 ```
 
-### Cleanup after Merge request
-
+### Cleanup after pull request
 ```sh
 $ git branch -d <branch name>
 $ git push origin master
 ```
+
+## Coding Rules
+
+### Javascript
+
+#### Code Style
+Use StandardJS to validate code-style `yarn standard`.
+
+#### Supported Language
+Use ES6 version for Javascript code. https://standardjs.com
+
+#### Variables and Classes
+For all var, let, const and method names you should use camelCase.
+
+Exceptions to the rule:
+* Class names for ES6 with camelCase and first Uppercase letter.
+* Constructors for ES5 with camelCase and first Uppercase letter.
+
+#### No jQuery
+Contributor should try not to use jQuery and jQuery-like libraries.
+
+## Installation instruction
+All javascript is build with webpack module builder. Install the plugin and checked that it works, you can make changes to it to get acquainted with the code.
+
+### Requirements
+* PHP >= 5.4
+* WordPress >= 4.6
+* PHP `gd2/imagick` extension to be loaded
+* Node >=8.0
+* npm >=5.8
+* yarn
+
+Locate plugin folder in your WordPress installation under `wp-content/plugins` and clone builder repo here.
+
+##### 1. Install node modules and php composer dependencies
+``` sh
+$ yarn install
+$ php ci/composer.phar update
+```
+
+##### 2. Build project
+```sh
+$ yarn build
+# watch
+$ yarn watch
+```
+##### 3. Build settings (Welcome page, Activation page)
+```sh
+$ yarn build-settings
+# watch
+$ yarn watch-settings
+```
+
+##### 4. Build elements
+```sh
+$ bash tools/elements/buildScript.sh
+# or production version
+$ bash tools/elements/buildProductionScript.sh
+```
+You can build each element separately.
+```sh
+$ cd elements/{elementDirectory}
+$ ../../node_modules/.bin/webpack --config webpack.config.4x.babel.js --progress --colors
+# compile style.css and watch
+$ ../../node_modules/.bin/webpack --config webpack.config.4x.babel.js --progress --colors --watch /public/src/init.less styles.css --autoprefix="last 2 versions"
+```
+You need to build public assets for element if exist.
+```sh
+$ cd elements/{elementDirectory}/{elementDirectory}/public
+# build
+$ ../../../../node_modules/.bin/webpack --config=webpack.config.js -p
+# watch
+$ ../../../../node_modules/.bin/webpack --config=webpack.config.js -p --watch
+```
+
+##### Build assets
+```sh
+$ cd public/sources/assetsLibrary/{assetDirectory}
+$ ../../../../node_modules/.bin/webpack --config=webpack.config.babel.js -p
+```
+
+##### Install local githooks
+Git hooks will add pre-commit hooks to keep commits clean.
+```sh
+$ cd _infrastructure
+$ ./install-hooks
+```
+
+##### Debug mode
+You can enable debug mode by adding `env-dev.php` file to the root directory of the project.
+```php
+<?php
+
+if (!VcvEnv::has('VCV_DEBUG')) {
+    VcvEnv::set('VCV_DEBUG', true);
+}
+require_once "env.php";
+```
+
+
diff --git a/README.md b/README.md
@@ -1,84 +1,19 @@
 # Visual Composer Website Builder
+Visual Composer Website Builder is a drag and drop editor for WordPress. With an easy-to-use interface, it allows you to design layouts you always wanted. Coupled with premium templates, blocks, elements, and extensions - Visual Composer is all you need to create a website.
 
-[![build status](https://gitlab.com/visual-composer-website-builder/builder/badges/master/build.svg)](https://gitlab.com/visual-composer-website-builder/builder/commits/master)
-[![coverage report](https://gitlab.com/visual-composer-website-builder/builder/badges/master/coverage.svg)](https://gitlab.com/visual-composer-website-builder/builder/commits/master)
+## Installation
+Read [Installation instruction](./CONTRIBUTING.md#installation-instruction) in our [contributing guide](./CONTRIBUTING.md).
 
+## Builder for Developers
+Visual Composer API allows you to develop your own custom elements for the website builder.
+[Get started](https://visualcomposer.com/help/api/)
 
-## Javascript Code Style
-* Use StandardJS to validate code-style `yarn standard`.
 
-## Supported Language
-Use ES6 version for Javascript code. https://standardjs.com
+## Changelog
+Check the [list of the latest improvements](./CHANGELOG.md).
 
-## Variables and Classes
-For all var, let, const and method names you should use camelCase.
-Exceptions to the rule:
-* Class names for ES6 with camelCase and first Uppercase letter.
-* Constructors for ES5 with camelCase and first Uppercase letter.
+## Contributing
+Read our [contributing guide](./CONTRIBUTING.md) to learn about our development process. How to build your changes to Visual Composer.
 
-## No jQuery
-Contributor should try not to use jQuery and jQuery-like libraries.
-
-## Requirements
-* PHP > 5.4
-* WordPress > 4.6
-* PHP `gd2/imagick` extension to be loaded
-* Node
-* npm
-* `npm install -g yarn`
-
-## Installation instruction
-All javascript is build with webpack module builder.
-
-``` sh
-$ yarn install
-$ php ci/composer.phar update
-```
-### Environment Configuration in Javascript
-If you want to setup custom environment configuration settings,3 you can use *custom-variables.js* by c it from default-variables.js.
-
-### Feature toggle and environment Configuration in Javascript
-To build a deliverable product use feature toggle to enable/disable some code features and fixes. Default state of feature toggle is set in *default-variables.js*. 
-You can customize settings by creating copy of variables file *default-variables.js* with a git ignored filename *custom-variables.js*.
-
-### Install local githooks
-```sh
-$ cd _infrastructure
-$ ./install-hooks
-```
-### Build project
-```sh
-$ yarn build
-```
-### Build settings (Welcome page, Activation page)
-```sh
-$ yarn build-settings
-```
-### Start watcher
-```sh
-$ yarn watch
-```
-
-###  Add elements ###
-```sh
-$ bash tools/elements/buildScript.sh
-## or production version
-$ bash tools/elements/buildProductionScript.sh
-```
-
-### env-dev.php example
-```php
-<?php
-
-if (!VcvEnv::has('VCV_DEBUG')) {
-    VcvEnv::set('VCV_DEBUG', true);
-}
-require_once "env.php";
-```
-
-## Build Wordpress plugin package (zip archive)
-```sh
-git clone account-project
-node [account-project]_infrastructure/vcwb-builder/builder plugin -p <directoryWhereToPlaceZipArchive>
-node [account-project]_infrastructure/vcwb-builder/builder plugin --help # for more info
-```
+## License
+Visual Composer is [GPL licensed](./license.txt).
diff --git a/package.json b/package.json
@@ -1,11 +1,11 @@
 {
   "name": "vcwb",
-  "version": "2.3.0-dev",
-  "description": "VC Website Builder",
+  "version": "dev",
+  "description": "Visual Composer Website Builder",
   "main": "index.php",
   "repository": {
     "type": "git",
-    "url": "git@gitlab.com:visual-composer-website-builder/builder.git"
+    "url": "git@github.com:Visualcomposer/builder.git"
   },
   "scripts": {
     "test": "BABEL_ENV=test BABEL_JEST_STAGE=0 bash ./tests/jest/devElements/_cloneScript.sh && jest --env=jsdom",
@@ -14,16 +14,15 @@
     "build-production": "webpack --version && webpack --config webpack.config.production.4x.babel.js -p",
     "build-production-silent": "webpack --version && webpack --config webpack.config.production.4x.babel.js -p --silent",
     "watch": "webpack --version && webpack --config webpack.config.4x.babel.js --progress --colors --watch",
-    "watch-assets-and-elements": "vc watch-elements-and-assets",
     "build-settings": "webpack --version && webpack --config webpack-settings.config.4x.babel.js --progress --colors",
     "build-settings-production": "webpack --version && webpack --config webpack-settings.config.production.4x.babel.js -p --silent",
     "watch-settings": "webpack --version && webpack --config webpack-settings.config.4x.babel.js --progress --colors --watch",
     "testcafe-live": "testcafe-live chrome tests/testcafe"
   },
-  "author": "@wpb",
+  "author": "@visualcomposer",
   "license": "GPL-2.0+",
   "engines": {
-    "node": ">=9",
+    "node": ">=8",
     "npm": ">=5.8"
   },
   "devDependencies": {
