Merge branch 'master' of https://github.com/cypress-io/cypress-documentation into master

.

Author: shawnhelps

.circleci/config.yml

@@ -36,10 +36,13 @@ commands:
           name: Broken link checker for changed files
           command: yarn changed-files-broken-link-checker:ci
 
+job-defaults: &job-defaults
+  executor: node-executor
+  working_directory: ~/repo
+
 jobs:
   build:
-    executor: node-executor
-    working_directory: ~/repo
+    <<: *job-defaults
     steps:
       - nuxt-build
       - persist_to_workspace:
@@ -49,17 +52,23 @@ jobs:
             - node_modules/*
 
   link-check-changed-files:
-    executor: node-executor
-    working_directory: ~/repo
+    <<: *job-defaults
     steps:
       - checkout
       - attach_workspace:
           at: ~/repo
       - link-check-changed-files
 
+  lint:
+    <<: *job-defaults
+    steps:
+      - checkout
+      - attach_workspace:
+          at: ~/repo
+      - run: yarn lint
+
   broken-link-check-prod:
-    executor: node-executor
-    working_directory: ~/repo
+    <<: *job-defaults
     steps:
       - checkout
       - restore_cache:
@@ -73,15 +82,15 @@ jobs:
           command: yarn broken-link-checker:prod
 
   release:
-    executor: node-executor
+    <<: *job-defaults
     steps:
       - nuxt-build
       - run:
           name: Docsearch Scraper
           command: node ./cy_scripts/scrape.js
 
   publish-scheduled-sanity-content:
-    executor: node-executor
+    <<: *job-defaults
     steps:
       - checkout
       - restore_cache:
@@ -113,6 +122,11 @@ workflows:
           requires:
             - build
 
+      - lint:
+          name: "Lint JS/CSS/Markdown"
+          requires:
+            - build
+
       # Run E2E tests in Chrome
       - cypress/run:
           name: 'UI Tests - Chrome'

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,68 @@
+name: "Bug Report"
+description: "File a bug report"
+labels: ["type: bug"]
+body:
+  - type: "markdown"
+    attributes:
+      value: |
+        Thanks for creating an issue 😄!
+
+        Please search open/closed issues before submitting. Someone
+        might have asked the same thing before 😉!
+
+        We're all volunteers here, so help us help you by taking the time to
+        accurately fill out this template. ❤️
+  - type: "input"
+    id: "description"
+    attributes:
+      label: "Description"
+      description: "A brief description of the issue(s)."
+      placeholder: |
+        When I ____, I expected ____ to happen but ____ happened instead.
+    validations:
+      required: true
+  - type: "input"
+    id: "link"
+    attributes:
+      label: "URL of Issue(s)"
+      description: |
+        A link to the production environment which demonstrates the bug.
+      placeholder: "https://docs.cypress.io/"
+    validations:
+      required: true
+  - type: "textarea"
+    id: "steps"
+    attributes:
+      label: "Steps to replicate"
+      description: |
+        Explain how to cause the issue in the provided reproduction.
+      value: |
+        1. Go to '...'
+        2. Click on '...'
+        3. Scroll down to '...'
+        4. See error
+  - type: "input"
+    id: "browser"
+    attributes:
+      label: "Browser"
+      description: "The browser(s) this issue occurred with."
+      placeholder: "Google Chrome 95"
+  - type: "checkboxes"
+    id: "device"
+    attributes:
+      label: "Device"
+      description: "The devices(s) this issue occurred with."
+      options:
+        - label: "PC"
+        - label: "Mac"
+        - label: "iPhone"
+        - label: "iPad"
+        - label: "Android Phone"
+        - label: "Android Tablet"
+  - type: "textarea"
+    id: "additional-information"
+    attributes:
+      label: "Additional Information"
+      description: |
+        Use this section to provide any additional information you might have
+        like screenshots, notes, or links to ideas.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,30 @@
+name: "Documentation Request"
+description: "Request for documentation to be added/altered"
+labels: ["content: rewrite"]
+body:
+  - type: "markdown"
+    attributes:
+      value: |
+        Thanks for filing a documentation request!
+
+        If you have an idea for a new documentation topic, noticed that
+        something is not properly documented, or feel that something is
+        incorrect with the current documentation, you're in the right place!
+  - type: "input"
+    id: "subject"
+    attributes:
+      label: "Subject"
+      description:
+        "What is the subject (guides, api, plugins, examples, faq) of this request?"
+      placeholder: "Guides"
+    validations:
+      required: true
+  - type: "textarea"
+    id: "description"
+    attributes:
+      label: "Description"
+      description:
+        "What about the subject's documentation should be added or changed?"
+      placeholder: "Update Guides with new 'Migrating to Cypress' page"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/documentation_request.yml

@@ -0,0 +1,32 @@
+<!---
+Thanks for creating a Pull Request 💖!
+
+Please read the following before submitting:
+- PRs that adds new external dependencies might take a while to review.
+- Keep your PR as small as possible.
+- Limit your PR to one type (docs, refactor, ci, or bugfix)
+-->
+
+# Github Issue :octocat:
+
+Closes # <!-- Github issue # here -->
+
+## 📝 Purpose of Pull Request
+
+> Add a brief description
+
+## 🤔 How to Setup
+
+### 📄 Page(s) to test
+
+> Please provide links to the changes if applicable
+
+### ✅ Steps to run pull request
+
+> Please describe the behavior or changes to run this PR
+
+## 📸 Proof of Change
+
+> Place screenshots or GIFs of visual changes if applicable
+
+## 📝 Additional Information

.github/PULL_REQUEST_TEMPLATE/issue_template.md

@@ -1,75 +1,2 @@
-# Contributor 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
-[[email protected]](mailto:[email protected]). All complaints will be reviewed and
-investigated and will result in a response that is deemed necessary and
-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
-https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
+Please review our
+[Code of Conduct](https://github.com/cypress-io/cypress/blob/develop/CODE_OF_CONDUCT.md).