Merge branch 'master' of github.com:pustovitDmytro/npm-boilerplate

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+dipustovit@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md → .github/PULL_REQUEST_TEMPLATE.md

@@ -10,7 +10,9 @@ Please, go through these steps before you submit a PR:
 
     c. You have only one commit (if not, squash them into one commit).
 
-    d. `npm test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`).
+    d. Commit message follows [convention](../CONTRIBUTING.md#commit-message). Good example is: `Docs: fixes typo in 'rejection' word`.
+
+    e. `npm test` doesn't throw any error. If it does, fix them first and amend your commit (`git commit --amend`).
 
 3. **After** these steps, you're ready to open a pull request.
 
@@ -26,10 +28,7 @@ Please, go through these steps before you submit a PR:
 
 **IMPORTANT**: Please review the [CONTRIBUTING](../#contribute) section for detailed contributing guidelines.
 
-**PLEASE REMOVE THIS NOTES BEFORE SUBMITTING**
-
-
-
+**PLEASE REMOVE THESE NOTES BEFORE SUBMITTING**
 
 
 **Fixes** #XX

.github/PULL_REQUEST_TEMPLATE/typo.md

@@ -0,0 +1,26 @@
+Please, go through these steps before you submit a PR:
+1. Make sure that your PR is not a duplicate.
+2. If not, then make sure that:
+    a. You have done your changes in a separate branch. Branches MUST have descriptive names that start with `docs/` prefix. Good examples are: `docs/readme-typo` or `docs/typo-guideline`.
+    b. You have a descriptive commit message with a short title (first line).
+    c. You have only one commit (if not, squash them into one commit).
+    d. Commit message follows [convention](../CONTRIBUTING.md#commit-message). Good example is: `Docs: fixes typo in 'rejection' word`.
+    e. The changes relate to the documentation only (README.md .github/* docs/*). **Use another pr template otherwise**.
+
+3. **After** these steps, you're ready to open a pull request.
+    a. Give a descriptive title to your PR.
+    b. Describe your changes. Add link to the generally accepted dictionary with correct usage.
+    c. In case there is an opened issue, put `closes #XXXX` in your comment to auto-close the issue that your PR fixes.
+
+
+**PLEASE REMOVE THESE NOTES BEFORE SUBMITTING**
+
+
+**Fixes typo** [ word / sentence / filename ]
+
+Describe your changes:
+
+<!-- Example: This PR fixes typo in 'rejection' word. -->
+
+Add link to the generally accepted dictionary with correct usage:
+<!-- Example: https://www.lexico.com/definition/rejection-->

.sonarcloud.properties

@@ -0,0 +1,15 @@
+# Path to sources
+sonar.sources=src
+#sonar.exclusions=
+#sonar.inclusions=
+
+# Path to tests
+sonar.tests=tests
+#sonar.test.exclusions=
+#sonar.test.inclusions=
+
+# Source encoding
+sonar.sourceEncoding=UTF-8
+
+# Exclusions for copy-paste detection
+sonar.cpd.exclusions=tests

README.md

@@ -13,7 +13,7 @@
 [![Scrutinizer][scrutinizer-badge]][scrutinizer-url]
 
 [![Dependencies][badge-deps]][npm]
-[![Vulnerabilities][badge-vuln]](https://snyk.io/)
+[![Security][snyk-badge]][snyk-url]
 [![Build Status][tests-badge]][tests-url]
 [![Coverage Status][badge-coverage]][url-coverage]
 
@@ -189,6 +189,9 @@ Make the changes to the code and tests. Then commit to your branch. Be sure to f
 [badge-coverage]: https://coveralls.io/repos/github/pustovitDmytro/rest-chronicle/badge.svg?branch=master
 [url-coverage]: https://coveralls.io/github/pustovitDmytro/rest-chronicle?branch=master
 
+[snyk-badge]: https://snyk-widget.herokuapp.com/badge/npm/rest-chronicle/badge.svg
+[snyk-url]: https://snyk.io/advisor/npm-package/rest-chronicle
+
 [tests-badge]: https://img.shields.io/circleci/build/github/pustovitDmytro/rest-chronicle
 [tests-url]: https://app.circleci.com/pipelines/github/pustovitDmytro/rest-chronicle