Update general repository and package documentations and metadata

The project repository documentations were not designed for a monorepo layout and have been updated including various badges provided by the great shields.io (1) project. Further documentations about the project architecture and technologies as well as guides for contributions to develop, run and maintain the project will stay within the packages itself. Minimal instructions might be added later on within a "Getting Starte" / "Quick Start" section. There are also various places that contain outdated documentations and metadata that have been updated too: - Updated outdated documentations and metadata like copyright comment headers. - Added GitHub user `svengreb` as core team maintainer to the CODEWONER file. - Added a new `.yarnrc` configuration file to set the `save-prefix` option in order to resolve always install and resolve exact dependency versions. - Updated project repository SVG assets using GitHub's new `sanitize=true` query parameter to allow rendering SVG's hosted within the repository and served via the `raw.githubusercontent` subdomain. - Added shields.io (1) badges for - latest GitHub release version and changelog - deployed ESLint package versions and statistics (downloads) References: (1) https://shields.io Epic: GH-8 Resolves GH-14
svengreb · Aug 15, 2019 · be122b1 · be122b1
1 parent b4cac34
commit be122b1
Show file tree

Hide file tree

Showing 21 changed files with 16,222 additions and 4,293 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -1,5 +1,5 @@
 # Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
-# Copyright (c) 2018-present Sven Greb <code@svengreb.de>
+# Copyright (c) 2018-present Sven Greb <development@svengreb.de>
 
 # Project:    Styleguide JavaScript
 # Repository: https://github.com/arcticicestudio/styleguide-javascript

diff --git a/.editorconfig b/.editorconfig
@@ -1,3 +1,10 @@
+# Copyright (C) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+# Copyright (C) 2018-present Sven Greb <development@svengreb.de>
+#
+# Project:    Styleguide JavaScript
+# Repository: https://github.com/arcticicestudio/styleguide-javascript
+# License:    MIT
+
 # +--------------------+
 # + Base Configuration +
 # +--------------------+
@@ -14,6 +21,6 @@ trim_trailing_whitespace = true
 # + Languages +
 # +-----------+
 # +--- Markdown ---+
-[*.{md,gfm}]
+[*.{md}]
 max_line_length = off
 trim_trailing_whitespace = false
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -8,3 +8,4 @@
 # + Default Code Owner +
 # +--------------------+
 * @arcticicestudio
+* @svengreb
diff --git a/.npmrc b/.npmrc
@@ -1,2 +1,14 @@
-package-lock=false
+# Copyright (C) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+# Copyright (C) 2018-present Sven Greb <development@svengreb.de>
+#
+# Project:    Styleguide JavaScript
+# Repository: https://github.com/arcticicestudio/styleguide-javascript
+# License:    MIT
+
+# Always use a lockfile to pin dependency versions, improve the security through integrity hashsum checks
+# and prevents possible errors caused by updated transitive dependencies.
+package-lock=true
+
+# Automatically pin dependencies to exact versions instead of resolving to latest minor and patch updates.
+# This prevents possible errors caused by updated transitive dependencies.
 save-exact=true
diff --git a/.remarkignore b/.remarkignore
@@ -1,5 +1,8 @@
-# +---------+
-# + Node.js +
-# +---------+
-src/node_modules/*
-node_modules/*
+# Copyright (C) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+# Copyright (C) 2018-present Sven Greb <development@svengreb.de>
+#
+# Project:    Styleguide JavaScript
+# Repository: https://github.com/arcticicestudio/styleguide-javascript
+# License:    MIT
+
+**/node_modules/*
diff --git a/.remarkrc.js b/.remarkrc.js
@@ -1,17 +1,16 @@
 /*
- * Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
- * Copyright (c) 2018-present Sven Greb <code@svengreb.de>
+ * Copyright (C) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+ * Copyright (C) 2018-present Sven Greb <development@svengreb.de>
  *
  * Project:    Styleguide JavaScript
  * Repository: https://github.com/arcticicestudio/styleguide-javascript
  * License:    MIT
  */
 
 /**
- * @file The remark-lint configuration.
- * @author Arctic Ice Studio <development@arcticicestudio.com>
+ * The remark-lint configuration.
+ * @see https://github.com/remarkjs/remark-lint#configuring-remark-lint
  */
-
 module.exports = {
   plugins: ["remark-preset-lint-arcticicestudio"]
 };
diff --git a/.yarnrc b/.yarnrc
@@ -0,0 +1,10 @@
+# Copyright (C) 2018-present Arctic Ice Studio <development@arcticicestudio.com>
+# Copyright (C) 2018-present Sven Greb <development@svengreb.de>
+#
+# Project:    Styleguide JavaScript
+# Repository: https://github.com/arcticicestudio/styleguide-javascript
+# License:    MIT
+
+# Automatically pin dependencies to exact versions instead of resolving to latest minor and patch updates.
+# This prevents possible errors caused by updated transitive dependencies.
+save-prefix ""
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,28 +1,48 @@
-<p align="center"><img src="https://rawgit.com/arcticicestudio/styleguide-javascript/develop/assets/styleguide-javascript-banner-typography.svg"/></p>
+<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/styleguide-javascript/develop/assets/images/repository-hero.svg?sanitize=true"/></p>
 
-<p align="center"><img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/styleguide-javascript/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-javascript.svg?style=flat-square"/></a></p>
+<p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascript/releases/latest" target="_blank"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-javascript.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a> <a href="https://arcticicestudio.github.io/styleguide-javascript" target="_blank"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-javascript.svg?style=flat-square&label=Docs&logo=read-the-docs&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a></p>
 
-<p align="center">The Arctic Ice Studio JavaScript Code Style based on the <a href="https://github.com/airbnb/javascript">Airbnb JavaScript Style Guide</a>.</p>
+<p align="center">Changelog for the official<a href="https://github.com/arcticicestudio/styleguide-javascript" target="_blank">Arctic Ice Studio JavaScript Code Style</a></p>
+
+<!--lint disable no-duplicate-headings no-duplicate-headings-in-section-->
 
 # 0.1.0
 
-![Release Date: 2018-01-27](https://img.shields.io/badge/Release_Date-2018--01--28-88C0D0.svg?style=flat-square) [![Project Board](https://img.shields.io/badge/Project_Board-0.1.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/styleguide-javascript/projects/2) [![Milestone](https://img.shields.io/badge/Milestone-0.1.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/styleguide-javascript/milestone/1)
+![Release Date: 2018-01-27](https://img.shields.io/static/v1.svg?style=flat-square&label=Release%20Date&message=2018-01-27&colorA=4c566a&colorB=88c0d0) [![Project Board](https://img.shields.io/static/v1.svg?style=flat-square&label=Project%20Board&message=0.1.0&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0)](https://github.com/arcticicestudio/styleguide-javascript/projects/2) [![Milestone](https://img.shields.io/static/v1.svg?style=flat-square&label=Milestone&message=0.1.0&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0)](https://github.com/arcticicestudio/styleguide-javascript/milestone/1)
 
 > Detailed information can be found in the [project documentation][docs].
 
 ## Features
 
 ### Style Guide
 
-❯ Added the initial style guide with chapters to learn about the [comprehensive base rules][docs-rules]. (#1 in PR #2, dee0441a)
+**Base Rules** — #1 ⇄ #2 (⊶ dee0441a)
+↠ Added the initial style guide with chapters to learn about the [comprehensive base rules][docs-rules].
+
+**Base Rules** — #3 ⇄ #4 (⊶ cee71142)
+↠ Added the initial style guide for [React][docs-rules-react] specific rules like [Higher-Order Components][docs-rules-react-hoc], the [component methods & properties ordering][docs-rules-react-ordering-methods_and_properties] and [props][docs-rules-react-props].
+
+<p align="center"><img src="https://github.com/arcticicestudio/nord-docs/develop/assets/images/nord/repository-footer-separator.svg?sanitize=true" /></p>
+
+<p align="center">Copyright &copy; 2018-present <a href="https://www.arcticicestudio.com" target="_blank">Arctic Ice Studio</a> and <a href="https://www.svengreb.de" target="_blank">Sven Greb</a></p>
+
+<p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascript/blob/develop/LICENSE.md" target="_blank"><img src="https://img.shields.io/static/v1.svg?style=flat-square&label=License&message=MIT&logoColor=eceff4&logo=github&colorA=4c566a&colorB=88c0d0"/></a></p>
 
-❯ Added the initial style guide for [React][docs-rules-react] specific rules like e.g. [Higher-Order Components][docs-rules-react-hoc], the [component methods & properties ordering][docs-rules-react-ordering-methods_and_properties] and [props][docs-rules-react-props]. (#3 in PR #4, cee71142)
+---
 
-<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/assets/banner-footer-mountains.svg" /></p>
+<!--
++------------------+
++ Symbol Reference +
++------------------+
+↠ (U+21A0): Start of a log section description
+— (U+2014): Separator between a log section title and the metadata
+⇄ (U+21C4): Separator between a issue ID and pull request ID in a log metadata
+⊶ (U+22B6): Icon prefix for the short commit SHA checksum in a log metadata
+-->
 
-<p align="center">Copyright &copy; 2018-present Arctic Ice Studio & Sven Greb</p>
+<!--lint disable final-definition-->
 
-<p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascriptscript/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a></p>
+<!-- Base Links -->
 
 [docs-rules-react-hoc]: https://arcticicestudio.github.io/styleguide-javascript/rules/react/higher_order_components.html
 [docs-rules-react-ordering-methods_and_properties]: https://arcticicestudio.github.io/styleguide-javascript/rules/react/ordering.html#component-methods-and-properties

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,47 +1,46 @@
 # Code of Conduct
 
-All members, committers and volunteers in this project are required to act according to the following Code of Conduct. We ask you to follow these guidelines which help steer our interactions and strive to keep Styleguide JavaScript a positive and growing project and help us provide and ensure a safe environment for everyone.
+All (core) team members, contributors/committers and volunteers in this project are required to act according to the following Code of Conduct. We ask you to follow these guidelines which help steer our interactions and strive to keep “Styleguide JavaScript” a positive and growing project and help us provide and ensure a safe environment for everyone.
 
-If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact us via [email][email]. Your reports will be taken seriously and not dismissed or argued with.
+If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact us at support@arcticicestudio.com or directly to one of the core team members via [email][mailmap]. Your reports will be taken seriously and not dismissed or argued with.
 
 ## What we believe in and how we act
 
-- 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. We welcome people regardless of these or other attributes.
+- In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make 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. We welcome people regardless of these or other attributes.
 - Our community is based on mutual respect, tolerance, and encouragement.
 - We believe that a diverse community where people treat each other with respect is stronger, more vibrant and has more potential contributors and more sources for ideas. We aim for more diversity.
 - We are kind, welcoming and courteous to everyone.
+- We are focusing on what is best for the community.
 - We are respectful of others, their positions, their skills, their commitments and their efforts.
 - We are attentive in our communications, whether in person or online, and we are tactful and respectful when approaching differing views and experiences.
-- We are aware that language shapes reality. Thus, we use inclusive, gender-neutral language in the documents we provide and when we talk to people. When referring to a group of people, we aim to use gender-neutral terms like "team", "folks" or "everyone". <sup>[1][ref-gender-neutral-docs]</sup>
+- We are aware that language shapes reality. Thus, we use inclusive, gender-neutral language in the documents we provide and when we talk to people. When referring to a group of people, we aim to use gender-neutral terms like “team”, “folks” or “everyone”. <sup>[1][ref-gender-neutral-docs]</sup>
 - We respect that people have differences of opinion and criticize constructively.
 
-If you are being harassed, notice that someone else is being harassed, or have any other concerns, please contact us via [email][email]. Your reports will be taken seriously and not dismissed or argued with.
-
 ## Unacceptable Behavior
 
 - Do not be mean or rude.
 - Do not discriminate against anyone.
-- Sexism and racism of any kind (including sexist and racist "jokes"), demeaning or insulting behaviour and harassment are seen as direct violations to this Code of Conduct. Harassment includes offensive verbal comments related to age, body size, culture, ethnicity, gender expression, gender identity, level of experience, nationality, personal ability or disability, physical appearance, physical or mental difference, race, religion, set of skills, sexual orientation, socio-economic status, and subculture. Harassment also includes sexual images in public spaces, deliberate intimidation, stalking, following, harassing photography or recording, inappropriate physical contact, and unwelcome sexual attention.
+- Sexism and racism of any kind (including sexist and racist "jokes"), demeaning or insulting behavior and harassment are seen as direct violations to this Code of Conduct. Harassment includes offensive verbal comments related to age, body size, culture, ethnicity, gender expression, gender identity, level of experience, nationality, personal ability or disability, physical appearance, physical or mental difference, race, religion, set of skills, sexual orientation, socio-economic status, and subculture. Harassment also includes sexual images in public spaces, deliberate intimidation, stalking, following, harassing photography or recording, inappropriate physical contact, and unwelcome sexual attention.
 - Respect that some individuals and cultures consider the casual use of profanity offensive and off-putting.
 - Derailing, tone arguments and otherwise playing on people's desires to be nice are not welcome, especially in discussions about violations to this Code of Conduct.
 - Please avoid unstructured critique.
-- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behaviour is not welcome.
+- Likewise any spamming, trolling, flaming, baiting or other attention-stealing behavior is not welcome.
 - 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
 
 ## 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.
+The members of the core team and 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.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project core team members or owner via [email][email]. 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.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting us via support@arcticicestudio.com or directly to one of the project core team members or owner via [email][mailmap]. 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.
 
 ## Consequences for Violations
 
-If a participant engages in any behaviour violating this Code of Conduct, the core team members and project owner of this project may take any action they deem appropriate, including warning the offender or expulsion from the project, exclusion from any interaction and loss of all rights in this project.
+If a participant engages in any behavior violating this Code of Conduct, the core team members and project owner of this project may take any action they deem appropriate, including warning the offender or expulsion from the project, exclusion from any interaction and loss of all rights in this project.
 
 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.
 
@@ -53,7 +52,10 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ---
 
-Thanks for the inspirations and attributions to GitHub's [Open Source Guides](https://opensource.guide), [Hoodie's Code of Conduct](http://hood.ie/code-of-conduct) and the [Contributor Covenant Version 1.4](http://contributor-covenant.org/version/1/4/).
+Thanks for the inspirations and attributions to GitHub's [Open Source Guides][oss-guides], [Hoodie's Code of Conduct][hoodie-coc] and the [Contributor Covenant Version 1.4][contrib-cov-1.4].
 
-[email]: mailto:development@arcticicestudio.com
+[contrib-cov-1.4]: https://contributor-covenant.org/version/1/4/code-of-conduct
+[hoodie-coc]: http://hood.ie/code-of-conduct
+[mailmap]: https://github.com/arcticicestudio/styleguide-javascript/blob/develop/.mailmap
+[oss-guides]: https://opensource.guide
 [ref-gender-neutral-docs]: https://modelviewculture.com/pieces/gendered-language-feature-or-bug-in-software-documentation