feat: ✨ add semantic-release integration

Add semantic release integration to automate releases, versioning and
changelog generation

.travis.yml

@@ -2,26 +2,34 @@ os:
   - linux
   - osx
   # - windows - travis isn't windows ready yet; tests fail for meaningless reasons
+
 language: node_js
 node_js:
- - '10'
- - '8'
+  - 10
+  - 8
+
 install:
- - yarn install
- - yarn build
- - yarn add $WEBPACK $TSLOADER $VUELOADER -D
- - yarn lint
+  - yarn install --frozen-lockfile
+  - yarn build
+  - yarn add $WEBPACK $TSLOADER $VUELOADER -D
+
+script:
+  - yarn lint
+  - yarn test
+
 env:
- - WEBPACK=webpack@^5.0.0-alpha.5 TSLOADER=ts-loader@^5.0.0 VUELOADER=vue-loader@^15.2.4
- - WEBPACK=webpack@^4.0.0 TSLOADER=ts-loader@^5.0.0 VUELOADER=vue-loader@^15.2.4
- - WEBPACK=webpack@^3.10.0 TSLOADER=ts-loader@^3.4.0 VUELOADER=vue-loader@^13.5.0
- - WEBPACK=webpack@^2.7.0 TSLOADER=ts-loader@^3.4.0 VUELOADER=vue-loader@^13.5.0
-deploy:
-  provider: npm
-  email: piotrek.oles@gmail.com
-  skip_cleanup: true
-  api_key:
-    secure: bS5DICXIXzwMAxWhkZ6ks8q7O0rFaBIqmZNe+F3Vou/pMCcYbu1kRryD3sey3RvpdF768nG9ZqMCC+v3glN4hknizDb9mao5I581HvqL0j3hGB4BHuEho9j6GEEn0u6qr4biXOOHUy9/CPLu1xK6jsc3kOA56os1iUO6y7Z7yVgQvmfLBIMpDdwZ+TbkKMoBOZ1BGsz1q/vn2aIX67rQTfvSyu40r9QPuWI9itVevBK6SUwVa0AyYBxjJ0wlwwMLHY72+P5FF1QrwngwvFQsSSjXGvQ6n+xEXx2TR2YrFI+PLtXsBd1c9nQeAyUxGNJnJWAYKto+CjZo6ZISgeA6bpRr8jC1Lb2WVlkAMy5IN5F4SxS2vyehKaR5G6Ewm7y1Ft1RutIMAr3sy0UKSluD4k0sRX12S2SV8b0sK0z/VmtqX0vEcMo+hXgqloeiOf2ALbgbGk/uHGvzLlK/N/ypjFq+1sRFbpfGHxgGPR/FHq6zgmDJWq0T1b69T6a0MFEXzSvCoTDcN59ut8m5sBAfTwLZZ1XwGsd0DsYiEdQ8bZKh5INyOnynVEAYsggM2RgRRSkg8NwGC9W8CIGN0sAza19EcdeKQ9s6PaKQ9FL1hmyZgxGjV5MlrM5jCdeTEnwPNhIoKQh0SrhL+gcf2yqPRIiCRxI49RRDKwZ8fNvJPLk=
-  on:
-    tags: true
-    branch: master
+  - WEBPACK=webpack@^5.0.0-alpha.5 TSLOADER=ts-loader@^5.0.0 VUELOADER=vue-loader@^15.2.4
+  - WEBPACK=webpack@^4.0.0 TSLOADER=ts-loader@^5.0.0 VUELOADER=vue-loader@^15.2.4
+  - WEBPACK=webpack@^3.10.0 TSLOADER=ts-loader@^3.4.0 VUELOADER=vue-loader@^13.5.0
+  - WEBPACK=webpack@^2.7.0 TSLOADER=ts-loader@^3.4.0 VUELOADER=vue-loader@^13.5.0
+
+jobs:
+  include:
+    - stage: release
+      node_js: 10
+      script: skip
+      deploy:
+        provider: script
+        skip_cleanup: true
+        script:
+          - yarn exec semantic-release

CODE_OF_CONDUCT.md

@@ -0,0 +1,60 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
+participation in our project and our community a harassment-free experience for everyone, regardless of age,
+body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
+appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
+project or its community. Examples of representing a project or community include using an official project e-mail address,
+posting via an official social media account, or acting as an appointed representative at an online or offline event.
+Representation of a project may be 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
+piotrek.oles@gmail.com. The project team will review and investigate all complaints, and will respond
+in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality
+with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
+repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,204 @@
+# Contributing to fork-ts-checker-webpack-plugin
+
+✨ Thanks for contributing to **fork-ts-checker-webpack-plugin**! ✨
+
+As a contributor, here are the guidelines we would like you to follow:
+
+- [Code of conduct](#code-of-conduct)
+- [How can I contribute?](#how-can-i-contribute)
+- [Submitting a Pull Request](#submitting-a-pull-request)
+- [Coding rules](#coding-rules)
+- [Working with the code](#working-with-the-code)
+
+We also recommend that you read [How to Contribute to Open Source](https://opensource.guide/how-to-contribute).
+
+## Code of conduct
+
+Help us keep **fork-ts-checker-webpack-plugin** open and inclusive. Please read and follow our [Code of conduct](CODE_OF_CONDUCT.md).
+
+## How can I contribute?
+
+### Improve documentation
+
+As a **fork-ts-checker-webpack-plugin** user, you are the perfect candidate to help us improve our documentation: typo corrections, clarifications, more examples, etc. Take a look at the [documentation issues that need help](https://github.com/Realytics/fork-ts-checker-webpack-plugin/labels/docs).
+
+Please follow the [Documentation guidelines](#documentation).
+
+### Give feedback on issues
+
+Some issues are created without information requested in the [Bug report guideline](#bug-report). Help make them easier to resolve by adding any relevant information.
+
+Issues with the [design label](https://github.com/Realytics/fork-ts-checker-webpack-plugin/labels/design) are meant to discuss the implementation of new features. Participating in the discussion is a good opportunity to get involved and influence the future direction of **fork-ts-checker-webpack-plugin**.
+
+### Fix bugs and implement features
+
+Confirmed bugs and ready-to-implement features are marked with the [help wanted label](https://github.com/Realytics/fork-ts-checker-webpack-plugin/labels/bug). Post a comment on an issue to indicate you would like to work on it and to request help from the contributors and the community.
+
+### Bug report
+
+A good bug report shouldn't leave others needing to chase you for more information. Please try to be as detailed as possible in your report and fill the information requested in the bug report template.
+
+### Feature request
+
+Feature requests are welcome, but take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and fill the information requested in the feature request template
+
+## Submitting a Pull Request
+
+Good pull requests, whether patches, improvements, or new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
+
+**Please ask first** before embarking on any significant pull requests (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
+
+If you have never created a pull request before, welcome 🎉 😄. [Here is a great tutorial](https://opensource.guide/how-to-contribute/#opening-a-pull-request) on how to send one :)
+
+Here is a summary of the steps to follow:
+
+1. [Set up the workspace](#set-up-the-workspace)
+2. If you cloned a while ago, get the latest changes from upstream and update dependencies:
+
+```bash
+$ git checkout beta
+$ git pull upstream beta
+$ rm -rf node_modules
+$ yarn install
+```
+
+3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
+
+```bash
+$ git checkout -b <topic-branch-name>
+```
+
+4. Make your code changes, following the [Coding rules](#coding-rules)
+5. Push your topic branch up to your fork:
+
+```bash
+$ git push origin <topic-branch-name>
+```
+
+6. [Open a Pull Request](https://help.github.com/articles/creating-a-pull-request/#creating-the-pull-request) to the `beta` branch with a clear title and description.
+
+**Tips**:
+
+- For ambitious tasks, open a Pull Request as soon as possible with the `[WIP]` prefix in the title, in order to get feedback and help from the community.
+- [Allow maintainers to make changes to your Pull Request branch](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork). This way, we can rebase it and make some minor changes if necessary.
+  All changes we make will be done in new commit and we'll ask for your approval before merging them.
+
+## Coding rules
+
+### Source code
+
+To ensure consistency and quality throughout the source code, all code modifications must have:
+
+- No linting errors
+- A test for every possible case introduced by your code change
+- [Valid commit message(s)](#commit-message-guidelines)
+- Documentation for new features
+- Updated documentation for modified features
+
+### Documentation
+
+To ensure consistency and quality, all documentation modifications must:
+
+- Refer to brand in [bold](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) with proper capitalization, i.e. **GitHub**, **fork-ts-checker-webpack-plugin**, **npm**
+- Prefer [tables](https://help.github.com/articles/organizing-information-with-tables) over [lists](https://help.github.com/articles/basic-writing-and-formatting-syntax/#lists) when listing key values, i.e. List of options with their description
+- Use [links](https://help.github.com/articles/basic-writing-and-formatting-syntax/#links) when you are referring to:
+  - a \*fork-ts-checker-webpack-plugin\*\* concept described somewhere else in the documentation, i.e. How to [contribute](CONTRIBUTING.md)
+  - a third-party product/brand/service, i.e. Integrate with [GitHub](https://github.com)
+  - an external concept or feature, i.e. Create a [GitHub release](https://help.github.com/articles/creating-releases)
+  - a package or module, i.e. The [`typescript`](https://github.com/Microsoft/TypeScript) module
+- Use the the [single backtick `code` quoting](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code) for:
+  - commands inside sentences, i.e. the `tsc` command
+  - programming language keywords, i.e. `function`, `async`, `String`
+  - packages or modules, i.e. The [`typescript`](https://github.com/Microsoft/TypeScript) module
+- Use the the [triple backtick `code` formatting](https://help.github.com/articles/creating-and-highlighting-code-blocks) for:
+  - code examples
+  - configuration examples
+  - sequence of command lines
+
+### Commit message guidelines
+
+#### Atomic commits
+
+If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:
+
+- a commit should contain exactly one self-contained functional change
+- a functional change should be contained in exactly one commit
+- a commit should not create an inconsistent state (such as test errors, linting errors, partial fix, feature with documentation etc...)
+
+A complex feature can be broken down into multiple commits as long as each one maintains a consistent state and consists of a self-contained change.
+
+#### Commit message format
+
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
+
+```commit
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+The **footer** can contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages).
+
+#### Type
+
+The type is forced by the `commitlint` package. To see available types, run `yarn commit` or check [changelog.config.js](changelog.config.js) file
+
+#### Subject
+
+The subject contains succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize first letter
+- no dot (.) at the end
+
+#### Body
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+#### Footer
+
+The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
+
+**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.
+
+#### Examples
+
+```commit
+`fix(pencil): stop graphite breaking when too much pressure applied`
+```
+
+```commit
+perf(pencil): remove graphiteWidth option`
+
+The default graphite width of 10mm is always used for performance reasons.
+
+BREAKING CHANGE: The graphiteWidth option has been removed.
+```
+
+## Working with the code
+
+### Set up the workspace
+
+[Fork](https://guides.github.com/activities/forking/#fork) the project, [clone](https://guides.github.com/activities/forking/#clone) your fork, configure the remotes and install the dependencies:
+
+```bash
+# Clone your fork of the repo into the current directory
+$ git clone https://github.com/<your-username>/fork-ts-checker-webpack-plugin
+# Navigate to the newly cloned directory
+$ cd fork-ts-checker-webpack-plugin
+# Assign the original repo to a remote called "upstream"
+$ git remote add upstream https://github.com/Realytics/fork-ts-checker-webpack-plugin
+# Install the dependencies
+$ yarn install
+```
+
+### Commits
+
+This repository use [Commitizen](https://github.com/commitizen/cz-cli) to help you create [valid commit messages](#commit-message-guidelines).
+
+After staging your changes with `git add`, run `yarn commit` to start the interactive commit message CLI.