Initial commit

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,36 @@
+---
+name: Bug Report
+about: Report a bug to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description
+
+Please provide a description of the problem.
+
+## Expected Behaviour
+
+Please describe what you expected would happen.
+
+## Actual Behaviour
+
+Please describe what happened instead.
+
+## Affected Version
+
+Please provide the version number where this issue was encountered.
+
+## Steps to Reproduce
+
+1. First step
+1. Second step
+1. etc.
+
+## Checklist
+
+<!-- TODO: Update the link below to point to your project's contributing guidelines -->
+- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md)
+- [ ] I have verified this does not duplicate an existing issue

.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,25 @@
+---
+name: Feature Request
+about: Suggest a feature for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Problem Statement
+
+Please describe the problem to be addressed by the proposed feature.
+
+## Proposed Solution
+
+Please describe what you envision the solution to this problem would look like.
+
+## Alternatives Considered
+
+Please briefly describe which alternatives, if any, have been considered, including merits of alternate approaches and
+tradeoffs being made.
+
+## Additional Context
+
+Please provide any other information that may be relevant.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## Description
+
+Please provide a meaningful description of what this change will do, or is for. Bonus points for including links to related issues, other PRs, or technical references.
+
+Note that by _not_ including a description, you are asking reviewers to do extra work to understand the context of this change, which may lead to your PR taking much longer to review, or result in it not being reviewed at all.
+
+## Type of Change
+
+- [ ] Bug Fix
+- [ ] New Feature
+- [ ] Breaking Change
+- [ ] Refactor
+- [ ] Documentation
+- [ ] Other (please describe)
+
+## Checklist
+
+<!-- TODO: Update the link below to point to your project's contributing guidelines -->
+- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/oss-template/blob/main/CONTRIBUTING.md)
+- [ ] Existing issues have been referenced (where applicable)
+- [ ] I have verified this change is not present in other open pull requests
+- [ ] Functionality is documented
+- [ ] All code style checks pass
+- [ ] New code contribution is covered by automated tests
+- [ ] All new and existing tests pass

.github/workflows/lint.yml

@@ -0,0 +1,27 @@
+name: lint
+
+on: # Rebuild any PRs and main branch changes
+  push:
+    branches:
+      - main
+      - develop
+  pull_request:
+
+jobs:
+  markdown:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: ⬇️ lint markdown files # Lints all markdown (.md) files
+        uses: avto-dev/markdown-lint@v1
+        with:
+          config: '.markdownlint.json'
+          args: '**/*.md .github/**/*.md'
+  renovate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: 🧼 lint renovate config # Validates changes to renovate.json config file
+        uses: suzuki-shunsuke/[email protected]
+        with:
+          config_file_path: 'renovate.json'

.github/workflows/stale.yml

@@ -0,0 +1,25 @@
+name: stale
+
+on:
+  schedule:
+  - cron: "0 0 * * 0"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+    - name: 📆 mark stale PRs # Automatically marks inactive PRs as stale
+      uses: actions/stale@v6
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        days-before-stale: 60
+        stale-issue-label: 'stale'
+        stale-pr-label: 'stale'
+        stale-issue-message: 'Automatically marking issue as stale due to lack of activity'
+        stale-pr-message: 'Automatically marking pull request as stale due to lack of activity'
+        days-before-close: 7
+        close-issue-message: 'Automatically closing this issue as stale'
+        close-pr-message: 'Automatically closing this pull request as stale'

.markdownlint.json

@@ -0,0 +1,16 @@
+{
+    "default": true,
+    "MD013": {
+        "line_length": 10000,
+        "headings": false,
+        "code_blocks": false,
+        "tables": false
+    },
+    "MD024": {
+        "siblings_only": true
+    },
+    "MD025": {
+        "front_matter_title": ""
+    },
+    "MD041": false
+}

CHANGELOG.md

@@ -0,0 +1,128 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### TBA
+
+## [0.3.8] - 2022-08-15
+
+### Added
+
+- Recommended configuration for [renovate](https://github.com/renovatebot/renovate)
+- Linting workflow for `renovate.json` config
+
+### Changed
+
+- Pinned v4 of [github-pages-deploy-action](https://github.com/marketplace/actions/deploy-to-github-pages)
+- Removed [dependabot](https://github.com/dependabot) configuration
+
+## [0.3.7] - 2022-04-04
+
+### Changed
+
+- Update lint workflow trigger behavior
+
+## [0.3.6] - 2022-03-22
+
+### Added
+
+- Adds new template badges to README
+
+### Changed
+
+- Bumps [actions/checkout](https://github.com/marketplace/actions/checkout) from v2 to v3
+
+## [0.3.5] - 2021-10-21
+
+### Added
+
+- Add step to update contact information in Code of Conduct
+
+## [0.3.4] - 2021-10-19
+
+### Added
+
+- Dependabot configuration
+
+## [0.3.3] - 2021-10-07
+
+### Added
+
+- Markdown linting
+
+## [0.3.2] - 2021-08-24
+
+### Added
+
+- Version badge in README links to this changelog
+
+## [0.3.1] - 2021-08-02
+
+### Added
+
+- This changelog
+
+### Changed
+
+- Add versioning badge to README
+- Add step to remove contents of changelog to prevent confusion
+
+## [0.3.0] - 2021-07-21
+
+### Added
+
+- Integrate stale action
+
+### Changed
+
+- Add "Before you begin" section to README
+
+## [0.2.1] - 2021-06-08
+
+### Changed
+
+- Add explanation of why PR descriptions are so important
+
+## [0.2.0] - 2021-06-03
+
+### Added
+
+- Pull request template
+- Bug report template
+- Feature request template
+
+## [0.1.1] - 2021-05-24
+
+### Changed
+
+- Be more explicit about where the code of conduct applies
+
+## [0.1.0] - 2021-05-11
+
+### Added
+
+- Contributor Covenant
+- Contribution guidelines
+- Maintainers file
+- README template
+- Security guidance
+
+[unreleased]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.8...HEAD
+[0.3.8]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.7...v0.3.8
+[0.3.7]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.6...v0.3.7
+[0.3.6]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.5...v0.3.6
+[0.3.5]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.4...v0.3.5
+[0.3.4]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.3...v0.3.4
+[0.3.3]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.2...v0.3.3
+[0.3.2]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/wayfair-incubator/oss-template/compare/v0.2.1...v0.3.0
+[0.2.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/wayfair-incubator/oss-template/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/wayfair-incubator/oss-template/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/wayfair-incubator/oss-template/releases/tag/v0.1.0