Merge pull request #183 from WebDevStudios/staging

February 5 release

Author: Greg Rickaby

.env.local.example

@@ -0,0 +1,37 @@
+# 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"
+
+# Allows node to work with local self-signed certificates.
+NODE_TLS_REJECT_UNAUTHORIZED="0"
+
+# Your local WordPress URL.
+LOCAL_WORDPRESS_API_URL="https://nextjswp.test/"
+
+# Your development WordPress URL.
+DEV_WORDPRESS_API_URL="https://devwordpress.com"
+
+# Your staging WordPress URL.
+STAGING_WORDPRESS_API_URL="https://stagingwordpress.com/"
+
+# Your production WordPress URL.
+PROD_WORDPRESS_API_URL="https://productionwordpress.com/"
+
+# This needs to match PREVIEW_SECRET_TOKEN constant in wp-config.php. It can be any random string.
+WORDPRESS_PREVIEW_SECRET="ANY_RANDOM_STRING_SEE_README"
+
+# Your WordPress username.
+WORDPRESS_APPLICATION_USERNAME="YOUR_WORDPRESS_USERNAME"
+
+# Your WordPress application password. Requires WordPress 5.6 and above. See https://make.wordpress.org/core/2020/11/05/application-passwords-integration-guide/
+WORDPRESS_APPLICATION_PASSWORD="YOUR_GENERATED_APPLICATION_PASSWORD"
+
+# Your Algolia index name.
+NEXT_PUBLIC_LOCAL_ALGOLIA_INDEX_NAME="YOUR_ALGOLIA_INDEX_NAME"
+
+# Your Algolia application ID.
+NEXT_PUBLIC_ALGOLIA_APPLICATION_ID="YOUR_ALGOLIA_APP_ID"
+
+# Your Algolia search only key.
+NEXT_PUBLIC_ALGOLIA_SEARCH_ONLY_KEY="YOUR_ALGOLIA_SEARCH_ONLY_KEY"

.env.sample

@@ -1,13 +1,14 @@
+// https://eslint.org/docs/user-guide/configuring/
 module.exports = {
-  parser: 'babel-eslint',
   parserOptions: {
     ecmaFeatures: {
       jsx: true
     },
-    ecmaVersion: 9,
+    ecmaVersion: 2021,
     sourceType: 'module'
   },
   env: {
+    browser: true,
     node: true,
     es6: true
   },
@@ -16,23 +17,52 @@ module.exports = {
     'plugin:react/recommended',
     'plugin:react-hooks/recommended',
     'plugin:jsx-a11y/recommended',
-    'prettier'
+    'prettier',
+    'plugin:jsdoc/recommended'
   ],
   settings: {
     react: {
       version: 'detect'
+    },
+    jsdoc: {
+      tagNamePreference: {
+        returns: 'return'
+      }
     }
   },
-  plugins: ['react', 'react-hooks', 'jsx-a11y', 'prettier'],
+  plugins: ['react', 'react-hooks', 'jsx-a11y', 'prettier', 'jsdoc'],
   rules: {
+    'func-style': ['error', 'declaration'],
+    'jsdoc/check-indentation': 'warn',
+    'jsdoc/check-line-alignment': [
+      'warn',
+      'always',
+      {
+        tags: ['author', 'param', 'see']
+      }
+    ],
+    'jsdoc/require-param': [
+      'warn',
+      {
+        checkRestProperty: true,
+        unnamedRootBase: ['props']
+      }
+    ],
+    'jsdoc/check-values': [
+      'warn',
+      {
+        allowedAuthors: ['WebDevStudios']
+      }
+    ],
     'jsx-a11y/anchor-is-valid': 'off',
+    'no-console': ['error', {allow: ['warn', 'error']}],
+    'prettier/prettier': 'error',
     'react/react-in-jsx-scope': 'off',
     'react/jsx-filename-extension': [
-      1,
+      'warn',
       {
         extensions: ['.js', '.jsx']
       }
-    ],
-    'prettier/prettier': 'error'
+    ]
   }
 }

.eslintrc.js

@@ -1,4 +1,5 @@
-# These owners will be the default owners for everything in
-# the repo. Unless a later match takes precedence.
-# See https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
-*       @gregrickaby
+# Code Owners
+# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+*             @gregrickaby
+components/*  @itsamoreh @gregrickaby
+api/*         @ravewebdev @gregrickaby

.github/CODEOWNERS

@@ -1,14 +1,106 @@
-# How To Contribute
-
-WebDevStudios welcomes contributions and bug fixes from third-parties. Here are the steps to get started:
-
-* Create an [Issue](https://github.com/WebDevStudios/nextjs-wordpress-starter/issues) so we can all discuss your idea
-* Fork NextJS WordPress Starter
-* Create a feature/hotfix branch off [main](https://github.com/WebDevStudios/nextjs-wordpress-starter/tree/master)
-* Commit code changes to your feature/hotifx branch
-* Continue to merge master into your feature/hotifx branch so it stays current
-* Test across all major browsers
-* Accessibility testing (both WCAG 2.1AA and Section 508)
-* Must pass linting
-* Submit a [Pull Request](https://github.com/WebDevStudios/nextjs-wordpress-starter/pulls) and reference your Issue #
-* If everything tests out on our end, we may merge in your Pull Request
+# 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)
+  - [Tips to help your PR get approved](#tips-to-help-your-pr-get-approved)
+  - [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 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 ♻️
+
+### PR Preview Deployments
+
+[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.
+
+Learn more about [Vercel + Github integration](https://vercel.com/docs/git/vercel-for-github).
+
+### Code Linting
+
+This project has several rulesets and uses ESLint, Prettier, and Stylelint to enforce standards.
+
+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:
+
+```bash
+yarn run lint:js
+```
+
+Lint CSS:
+
+```bash
+yarn run lint:css
+```
+
+Format your code:
+
+```bash
+yarn run format
+```
+
+## Storybook
+
+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)
+
+---

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,44 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.
+
+If you leave out sections there is a high likelihood it will be moved to our [GitHub Discussions](https://github.com/WebDevStudios/nextjs-wordpress-starter/discussions).
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+
+- Device: [e.g. iPhone6]
+- OS: [e.g. iOS8.1]
+- Browser [e.g. stock browser, safari]
+- Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+**Please create your feature request as a [GitHub Discussion](https://github.com/WebDevStudios/nextjs-wordpress-starter/discussions).**
+
+Thank you!