Merge branch 'staging' into develop

Author: gregrickaby

.env.sample

@@ -1,3 +1,5 @@
+# Learn more about ENV variables at https://github.com/WebDevStudios/nextjs-wordpress-starter/wiki
+
 # Tells next.js we're in development mode
 VERCEL_ENV="development"
 

.eslintrc.js

@@ -1,3 +1,4 @@
+// https://eslint.org/docs/user-guide/configuring/
 module.exports = {
   parserOptions: {
     ecmaFeatures: {

.github/CONTRIBUTING.md

@@ -1,51 +1,65 @@
-# Thanks for contributing — you rock! 🤘 <!-- omit in toc -->
+# Contributing <!-- omit in toc -->
 
+## Introduction
+
+Thanks for contributing — you rock! 🤘
+
+Before getting started, please [view the wiki](https://github.com/WebDevStudios/nextjs-wordpress-starter/wiki) and read the following documentation.
+
+---
+
+## Table of Contents <!-- omit in toc -->
+
+- [Introduction](#introduction)
+- [Submitting Issues and Feature Requests](#submitting-issues-and-feature-requests)
 - [Development](#development)
-  - [Git Workflow](#git-workflow)
-  - [Deployments](#deployments)
-  - [Storybook](#storybook)
-- [Coding standards](#coding-standards)
   - [Tips to help your PR get approved](#tips-to-help-your-pr-get-approved)
-- [Submitting bug reports and feature requests](#submitting-bug-reports-and-feature-requests)
+  - [Git Workflow](#git-workflow)
+  - [PR Preview Deployments](#pr-preview-deployments)
+  - [Code Linting](#code-linting)
+- [Storybook](#storybook)
+- [Releases](#releases)
+
+---
+
+## Submitting Issues and Feature Requests
+
+Before submitting an issue or making a feature request, please search for existing [issues](https://github.com/WebDevStudios/nextjs-wordpress-starter/issues) or look at our [Github Discussions](https://github.com/WebDevStudios/nextjs-wordpress-starter/discussions).
+
+If you do file an issue, be sure to fill out the report completely!
+
+---
 
 ## Development
 
+### Tips to help your PR get approved
+
+1. Make sure your code editor supports real-time linting and has the [recommended extensions](https://github.com/WebDevStudios/nextjs-wordpress-starter/wiki/recommended-extensions) installed
+2. [JSDocs](https://jsdoc.app/) are required for all JavaScript functions
+3. Run `yarn build && yarn start` before submitting your PR, to ensure a build will be successful
+4. Be courteous in your communications
+
 ### Git Workflow
 
 1. Create a `feature` branch off `staging`
-2. Work locally adhereing to coding standards
+2. Work locally adhering to coding standards
 3. When ready, open a draft Pull Request on Github
 4. When finished, fill out the PR template and publish your PR
 5. Your PR must pass assertions and deploy successfully
 6. After peer review, the PR will be merged back into `staging`
 7. Repeat ♻️
 
-### Deployments
+### PR Preview Deployments
 
-[Vercel](https://nextjs-wordpress-starter-gregrickaby.webdevstudios.vercel.app) is connected to this Github repository and will automatically build and deploy. Learn more about [Vercel + Github integration](https://vercel.com/docs/git/vercel-for-github).
+[Vercel](https://vercel.com/webdevstudios/nextjs-wordpress-starter) is connected to this Github repository and will automatically build and deploy a unique URL for each Pull Request.
 
-### Storybook
+Learn more about [Vercel + Github integration](https://vercel.com/docs/git/vercel-for-github).
 
-To work with Storybook on your Local, run the following command:
+### Code Linting
 
-```bash
-yarn storybook
-```
+This project has several rulesets and uses ESLint, Prettier, and Stylelint to enforce standards.
 
-Stories are written in `.mdx` and should be placed next to the component. Learn more about [Storybook](https://storybook.js.org/).
-
-## Coding standards
-
-Pull requests _must pass_ all assertions and component changes will be reviewed in Chromatic prior to consideration.
-
-### Tips to help your PR get approved
-
-1. Make sure your code editor supports real-time linting.
-2. JSDocs are important and must be completely filled out.
-3. Run `yarn build && yarn start` before submitting your PR, to ensure a build will be successful
-4. Be courteous
-
-In addition to real-time linting, you could run the following commands in your terminal (these commands are also used by Husky during a commit!)
+In addition to real-time linting, you could run the following commands in your terminal. These commands are also used by Husky during a commit!
 
 Lint JavaScript:
 
@@ -65,8 +79,28 @@ Format your code:
 yarn run format
 ```
 
-## Submitting bug reports and feature requests
+## Storybook
 
-Before submitting an issue or making a feature request, please search for existing [issues](https://github.com/WebDevStudios/nextjs-wordpress-starter/issues) or look at our [Github Discussions](https://github.com/WebDevStudios/nextjs-wordpress-starter/discussions).
+To work with Storybook on your Local, run the following command:
+
+```bash
+yarn storybook
+```
+
+Stories are written in `.mdx` and should be placed next to the component.
+
+[Learn how to write stories for this starter](https://github.com/WebDevStudios/nextjs-wordpress-starter/wiki/component-story).
+
+---
+
+## Releases
+
+Releases to Production will occur at the end of a bi-weekly sprint or via `hotfixes` as needed.
+
+1. On Github, create a PR off the `/staging` branch against the `/main` branch
+2. Copy the WPE Staging environment to WPE Production.
+3. On Github, merge `/staging` into `/main`
+
+[Learn how to copy environments on WP Engine.](https://github.com/WebDevStudios/nextjs-wordpress-starter/wiki/Internal-Documentation#copy-wp-engine-environments)
 
-If you do fill out a bug report, be sure to fill out the report completely!
+---

.nvmrc

@@ -0,0 +1 @@
+12

.vscode/settings.json

@@ -11,5 +11,13 @@
   // This will get emmet working in JSX.
   "emmet.includeLanguages": {
     "javascript": "javascriptreact"
+  },
+
+  // 🔥 WebDevStudios - Your Success Is Our Mission. 🌮
+  "workbench.colorCustomizations": {
+    "titleBar.activeForeground": "#3f4040",
+    "titleBar.inactiveForeground": "#3f4040CC",
+    "titleBar.activeBackground": "#F3713C",
+    "titleBar.inactiveBackground": "#F3713CCC"
   }
 }