New: Contributing Guides

.gitlab-ci.yml

+image: node:8
+
+stages:
+  - docs
+
+docs:
+  stage: docs
+  script:
+    - .\publishDocs.ps1 $GITLAB_TOKEN
+  except:
+    variables:
+      - $GITLAB_USER_ID == $GIT_BOT_USER_ID
\ No newline at end of file

LICENSE

+MIT License
+
+Copyright (c) 2019 RWTH Aachen University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

+# Contributing Repository
+
+This repository describes the ways in which you can contribute to us!
+
+You can find the documentation here: https://git.rwth-aachen.de/coscine/templates/general-template/wikis/home
\ No newline at end of file

docs/ESLintConvention.md

+## ESLint Convention
+
+Make the changes to the code and tests and then commit to your branch. Be sure to follow the commit message conventions.
+
+Commit message summaries must follow this basic format:
+
+```
+Tag: Message (fixes #1234)
+```
+
+`Tag` should not be confused with git tag.
+`Message` should not be confused with git commit message.
+
+The `Tag` is one of the following:
+
+* `Fix` - for a bug fix.
+* `Update` - for a backwards-compatible enhancement.
+* `Breaking` - for a backwards-incompatible enhancement.
+* `Docs` - changes to documentation only.
+* `Build` - changes to build process only.
+* `New` - implemented a new feature.
+* `Upgrade` - for a dependency upgrade.
+
+The message summary should be a one-sentence description of the change. The issue number should be mentioned at the end. * The commit message should say "(fixes #1234)" at the end of the description if it closes out an existing issue (replace 1234 with the issue number). If the commit doesn't completely fix the issue, then use `(refs #1234)` instead of `(fixes #1234)`.
+
+Here are some good commit message summary examples:
+
+```
+Build: Update Travis to only test Node 0.10 (refs #734)
+Fix: Semi rule incorrectly flagging extra semicolon (fixes #840)
+Upgrade: Esprima to 1.2, switch to using Esprima comment attachment (fixes #730)
+```
+
+The commit message format is important because these messages are used to create a changelog for each release. The tag and issue number help to create more consistent and useful changelogs.
+
+Based on https://github.com/eslint/eslint.github.io/blob/master/docs/developer-guide/contributing.md#step-2-make-your-changes
+
+[npm-image]: https://badge.fury.io/js/conventional-changelog-eslint.svg
+[npm-url]: https://npmjs.org/package/conventional-changelog-eslint
+[travis-image]: https://travis-ci.org/stevemao/conventional-changelog-eslint.svg?branch=master
+[travis-url]: https://travis-ci.org/stevemao/conventional-changelog-eslint
+[daviddm-image]: https://david-dm.org/stevemao/conventional-changelog-eslint.svg?theme=shields.io
+[daviddm-url]: https://david-dm.org/stevemao/conventional-changelog-eslint
+[coveralls-image]: https://coveralls.io/repos/stevemao/conventional-changelog-eslint/badge.svg
+[coveralls-url]: https://coveralls.io/r/stevemao/conventional-changelog-eslint
\ No newline at end of file

docs/home.md

+# Contribution guide
+
+See [ESLint Convention](ESLintConvention) for our commit message convention.
+
+See [Local NPM workflow](npm) for our recommendation on how to work with local NPM packages.
\ No newline at end of file

docs/npm.md

+# Local NPM Workflow Guide
+
+For using local NPM libraries in your projects, you can use "npm link" to include them.
+
+## Usage
+
+1.  First you need to navigate to the needed NPM project
+2.  After that you execute "npm link" for creating a global symlink
+3.  Then you navigate to the project which needs the local project
+4.  With "npm link <project name>" you can then finally include the needed project locally
+
+## Example
+
+```
+cd <locally-needed-project-root>
+npm link # create a global symlink to the local needed project
+cd <project-needing-local-project-root>
+npm link <locally-needed-project-name> # create a symlink locally to global needed project symlink
+```
\ No newline at end of file

publishDocs.ps1

+param(
+    $token
+)
+
+$remoteUrl = git config --get remote.origin.url
+$remoteUrl = $remoteUrl.replace("git@", "")
+$remoteUrl = $remoteUrl -replace "https(.*?)@",""
+$remoteUrl = $remoteUrl.replace(":", "/")
+$remoteUrl = $remoteUrl.replace(".git", ".wiki.git")
+
+$temporaryFolderName = "publishDocsTempFolder"
+
+git clone "https://gitlab-ci-token:$($token)@$($remoteUrl)" $temporaryFolderName
+cd $temporaryFolderName
+Remove-Item *
+cp -r ../docs/* ./
+git add . 
+git commit -m "Docs: Documentation Update" 
+git push
\ No newline at end of file