Merge pull request #4 from arcticicestudio/improvement/gh-3-unordered…

…-marker-asterik-to-dash

Change unordered marker from asterisk to dash

.github/ISSUE_TEMPLATE.md

@@ -8,26 +8,26 @@ This section and the instructions in the sections below are only part of this is
 
 Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug report to help maintainers and the community understand and reproduce the behavior, find related reports and to resolve the ticket faster.
 
-* **Ensure the issue has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-markdown/issues)** — if it has **and the issue is still open**, add a comment to the existing issue instead of opening this new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
-* **Ensure the issue is reproducible** — try to use the [latest version](https://github.com/arcticicestudio/styleguide-markdown/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-markdown/tree/develop) branch.
+- **Ensure the issue has not already been reported by using the [GitHub Issues search](https://github.com/arcticicestudio/styleguide-markdown/issues)** — if it has **and the issue is still open**, add a comment to the existing issue instead of opening this new one. If you find a closed issue that seems to be similar to this one, include a link to the original issue in the [metadata head](#metadata-head) section of this issue.
+- **Ensure the issue is reproducible** — try to use the [latest version](https://github.com/arcticicestudio/styleguide-markdown/releases/latest) and [`develop`](https://github.com/arcticicestudio/styleguide-markdown/tree/develop) branch.
 
 ## Metadata Head
 
 The metadata head should be added to the top of the issue as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the [issue type](#issue-type) and if necessary the ID of other related issues.
 
 > Issue type:
-Related issues:
+> Related issues:
 
 ### Issue Type
 
 Set the *type* of this issue. It determines which information will be required in the following sections when it is an [bug report](https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CONTRIBUTING.md#bug-reports) or an [enhancement suggestion](https://github.com/arcticicestudio/styleguide-markdown/blob/develop/CONTRIBUTING.md#enhancement-suggestions).
 
-* *feature*
-* *improvement*
-* *bug*
-* *test*
-* *task*
-* *subtask*
+- *feature*
+- *improvement*
+- *bug*
+- *test*
+- *task*
+- *subtask*
 
 ## Description
 
@@ -61,12 +61,12 @@ Please provide the version of Styleguide Markdown your are using and optionally
 
 If possible please provide more context by answering these questions:
 
-* What is the version of *Styleguide Markdown* you are running?
-* What is the name and the version of your OS?
-  * Have you tried to reproduce it on different OS environments and if yes is the behavior the same for all?
-* If the problem is related to [Node.js](https://nodejs.org) please provide the Node.js version you're running.
-  * Are you using any additional CLI arguments for Node.js?
-* ... any additional information
+- What is the version of *Styleguide Markdown* you are running?
+- What is the name and the version of your OS?
+  - Have you tried to reproduce it on different OS environments and if yes is the behavior the same for all?
+- If the problem is related to [Node.js](https://nodejs.org) please provide the Node.js version you're running.
+  - Are you using any additional CLI arguments for Node.js?
+- ... any additional information
 
 ## Stack Trace and Error Messages
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -8,15 +8,15 @@ This section and the instructions in the sections below are only part of this pu
 
 Please do your best to provide as much information as possible and use a clear and descriptive title for your enhancement suggestion or bug fix to help maintainers and the community understand and reproduce the behavior, find related pull requests and to merge it faster.
 
-* **Ensure the pull request has not already been reported by using the [GitHub Pull Request search](https://github.com/arcticicestudio/styleguide-markdown/pulls)** — if it has **and the pull request is still open**, add a comment to the existing pull request instead of opening this new one. If you find a closed pull request that seems to be similar to this one, include a link to it in the [metadata head](#metadata-head) section of this pull request.
-* **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/styleguide-markdown/blob/feature/gh-12-github-open-source-community-standards/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations.
+- **Ensure the pull request has not already been reported by using the [GitHub Pull Request search](https://github.com/arcticicestudio/styleguide-markdown/pulls)** — if it has **and the pull request is still open**, add a comment to the existing pull request instead of opening this new one. If you find a closed pull request that seems to be similar to this one, include a link to it in the [metadata head](#metadata-head) section of this pull request.
+- **Ensure to adhere to the [pull request contribution guidelines](https://github.com/arcticicestudio/styleguide-markdown/blob/feature/gh-12-github-open-source-community-standards/CONTRIBUTING.md#pull-requests)**, especially the one for tests and documentations.
 
 ## Metadata Head
 
 The metadata head should be added to the top of the pull request as [Markdown text quote](https://help.github.com/articles/basic-writing-and-formatting-syntax) containing the [GitHub issue keywords](https://help.github.com/articles/closing-issues-using-keywords) to link to the related enhancements suggestions (`Closes`) or bug reports (`Fixes`). You can add additional details like dependencies to other pull requests and the order it needs to be merged.
 
 > Closes ISSUE_ID
-Must be merged **after**/**before** ISSUE_ID
+> Must be merged **after**/**before** ISSUE_ID
 
 ## Description
 

.remarkignore

@@ -3,3 +3,4 @@
 # +---------+
 src/node_modules/*
 node_modules/*
+LICENSE.md

.remarkrc.js

@@ -13,5 +13,9 @@
  */
 
 module.exports = {
-  plugins: ["remark-preset-lint-arcticicestudio"]
+  plugins: [
+    "remark-preset-lint-arcticicestudio",
+    /* Disabled to supress warnings about duplicate "Example" headings. */
+    ["remark-lint-no-duplicate-headings", false]
+  ]
 };

CHANGELOG.md

@@ -8,7 +8,6 @@
 
 <p align="center">The Arctic Ice Studio Markdown Code Style.</p>
 
-
 # 0.1.0
 
 ![Release Date: 2018-02-15](https://img.shields.io/badge/Release_Date-2018--02--15-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-markdown/projects/2) [![Milestone](https://img.shields.io/badge/Milestone-0.1.0-88C0D0.svg?style=flat-square)](https://github.com/arcticicestudio/styleguide-markdown/milestone/1)

CODE_OF_CONDUCT.md

@@ -6,28 +6,28 @@ If you are being harassed, notice that someone else is being harassed, or have a
 
 ## 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.
-* 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 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 respect that people have differences of opinion and criticize constructively.
+- 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.
+- 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 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 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.
-* 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.
-* 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
+- 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.
+- 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.
+- 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