From 2e0bd78a0fa4dd97debcd98bb7fc6c3bb74b08e6 Mon Sep 17 00:00:00 2001 From: John Hodges Date: Tue, 12 Oct 2021 08:52:17 -0400 Subject: [PATCH] v0.3.3 (#14) Add GitHub Action to lint Markdown on push and pull request --- .github/workflows/markdown-lint.yml | 16 ++++++++++++++ .markdownlint.json | 13 +++++++++++ CHANGELOG.md | 6 ++++- CODE_OF_CONDUCT.md | 6 ++--- CONTRIBUTING.md | 8 +++---- MAINTAINERS.md | 6 ++--- README.md | 34 ++++++++++++++--------------- SECURITY.md | 16 +++++++------- 8 files changed, 67 insertions(+), 38 deletions(-) create mode 100644 .github/workflows/markdown-lint.yml create mode 100644 .markdownlint.json diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml new file mode 100644 index 0000000..0022164 --- /dev/null +++ b/.github/workflows/markdown-lint.yml @@ -0,0 +1,16 @@ +name: Lint Markdown files + +on: ["push", "pull_request"] + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - name: Check out code + uses: actions/checkout@v2 + + - name: Lint Markdown files + uses: avto-dev/markdown-lint@v1 + with: + config: '.markdownlint.json' + args: '**/*.md .github/**/*.md' diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..cf11012 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,13 @@ +{ + "default": true, + "MD013": { + "line_length": 10000, + "headings": false, + "code_blocks": false, + "tables": false + }, + "MD024": { + "siblings_only": true + }, + "MD041": false +} diff --git a/CHANGELOG.md b/CHANGELOG.md index d0f2ca8..99f1cdb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,11 @@ 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] +## [0.3.3] - 2021-10-07 + +### Added + +- Markdown linting ## [0.3.2] - 2021-08-24 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index d8e2efa..111f191 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,4 +1,3 @@ - # Contributor Covenant Code of Conduct ## Our Pledge @@ -119,11 +118,11 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at [https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0]. -Community Impact Guidelines were inspired by +Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. For answers to common questions about this code of conduct, see the FAQ at -[https://www.contributor-covenant.org/faq][FAQ]. Translations are available +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. [homepage]: https://www.contributor-covenant.org @@ -131,4 +130,3 @@ at [https://www.contributor-covenant.org/translations][translations]. [Mozilla CoC]: https://github.com/mozilla/diversity [FAQ]: https://www.contributor-covenant.org/faq [translations]: https://www.contributor-covenant.org/translations - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a533cc..26da5eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -35,12 +35,12 @@ reserve breaking changes until the next major version release. We welcome anyone that wants to contribute to `` to triage and reply to open issues to help troubleshoot and fix existing bugs. Here is what you can do: -* Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section, +- Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section, providing feedback to the issue's author on what might be missing. -* Review and update the existing content of our [Wiki](https://github.com/org_name/repo_name/wiki) with up-to-date +- Review and update the existing content of our [Wiki](https://github.com/org_name/repo_name/wiki) with up-to-date instructions and code samples. -* Review existing pull requests, and testing patches against real existing applications that use ``. -* Write a test, or add a missing test case to an existing test. +- Review existing pull requests, and testing patches against real existing applications that use ``. +- Write a test, or add a missing test case to an existing test. Thanks again for your interest on contributing to ``! diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 8c5004c..422fdc0 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -1,5 +1,5 @@ # Maintainers -* [GitHub Username](https://github.com/username) -* [GitHub Username](https://github.com/username) -* [GitHub Username](https://github.com/username) +- [GitHub Username](https://github.com/username) +- [GitHub Username](https://github.com/username) +- [GitHub Username](https://github.com/username) diff --git a/README.md b/README.md index d9d2ec8..efd788e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # OSPO Project Template -[![OSS Template Version](https://img.shields.io/badge/OSS%20Template-0.3.2-7f187f.svg)](https://github.com/wayfair-incubator/oss-template/blob/main/CHANGELOG.md) +[![OSS Template Version](https://img.shields.io/badge/OSS%20Template-0.3.3-7f187f.svg)](https://github.com/wayfair-incubator/oss-template/blob/main/CHANGELOG.md) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md) -## Before You Start... +## Before You Start As much as possible, we have tried to provide enough tooling to get you up and running quickly and with a minimum of effort. This includes sane defaults for documentation; templates for bug reports, feature requests, and pull requests; and [GitHub Actions](https://github.com/features/actions) that will automatically manage stale issues and pull requests. This latter defaults to labeling issues and pull requests as stale after 60 days of inactivity, and closing them after 7 additional days of inactivity. These [defaults](.github/workflows/stale.yml) and more can be configured. For configuration options, please consult the documentation for the [stale action](https://github.com/actions/stale). @@ -12,17 +12,17 @@ In trying to keep this template as generic and reusable as possible, there are s - [ ] Select an appropriate license for your project. This can easily be achieved through the 'Add File' button on the GitHub UI, naming the file `LICENSE`, and selecting your desired license from the provided list. - [ ] Update the `` placeholder in this file to reflect the name of the license you selected above - [ ] Change references to `org_name` to the name of the org your repo belongs to (eg. `wayfair-incubator`) - - [ ] In [`README.md`](README.md) - - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) + - [ ] In [`README.md`](README.md) + - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) - [ ] Change references to `repo_name` to the name of your new repo - - [ ] In [`README.md`](README.md) - - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) + - [ ] In [`README.md`](README.md) + - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) - [ ] Update the link to the contribution guidelines to point to your project - - [ ] In [`.github/ISSUE_TEMPLATE/BUG_REPORT.md`](.github/ISSUE_TEMPLATE/BUG_REPORT.md) - - [ ] In [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) + - [ ] In [`.github/ISSUE_TEMPLATE/BUG_REPORT.md`](.github/ISSUE_TEMPLATE/BUG_REPORT.md) + - [ ] In [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) - [ ] Replace the `` placeholder with the name of your project - - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) - - [ ] In [`SECURITY.md`](SECURITY.md) + - [ ] In [`CONTRIBUTING.md`](CONTRIBUTING.md) + - [ ] In [`SECURITY.md`](SECURITY.md) - [ ] Add names and contact information for actual project maintainers to [`MAINTAINERS.md`](MAINTAINERS.md) - [ ] Delete the content of [`CHANGELOG.md`](CHANGELOG.md). We encourgage you to [keep a changelog](https://keepachangelog.com/en/1.0.0/). - [ ] Replace the generic content in this file with the relevant details about your project @@ -32,16 +32,16 @@ In trying to keep this template as generic and reusable as possible, there are s Provide some information about what the project is/does. - ## Getting Started To get a local copy up and running follow these simple steps. - ### Prerequisites This is an example of how to list things you need to use the software and how to install them. -* npm + +- npm + ```sh npm install npm@latest -g ``` @@ -49,37 +49,35 @@ This is an example of how to list things you need to use the software and how to ### Installation 1. Clone the repo + ```sh git clone https://github.com/org_name/repo_name.git ``` + 2. Install NPM packages + ```sh npm install ``` - ## Usage Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. _For more examples, please refer to the [Documentation](https://example.com) or the [Wiki](https://github.com/org_name/repo_name/wiki)_ - ## Roadmap See the [open issues](https://github.com/org_name/repo_name/issues) for a list of proposed features (and known issues). - ## Contributing Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. For detailed contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md) - ## License Distributed under the `` License. See `LICENSE` for more information. - ## Contact Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email diff --git a/SECURITY.md b/SECURITY.md index 8dd2c71..054eb81 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -3,9 +3,9 @@ This document outlines security procedures and general policies for the `` project. - * [Reporting a Bug](#reporting-a-bug) - * [Disclosure Policy](#disclosure-policy) - * [Comments on this Policy](#comments-on-this-policy) +- [Reporting a Bug](#reporting-a-bug) +- [Disclosure Policy](#disclosure-policy) +- [Comments on this Policy](#comments-on-this-policy) ## Reporting a Bug @@ -28,12 +28,12 @@ When the security team receives a security bug report, they will assign it to a primary handler. This person will coordinate the fix and release process, involving the following steps: - * Confirm the problem and determine the affected versions. - * Audit code to find any potential similar problems. - * Prepare fixes for all releases still under maintenance. These fixes will be - released as quickly as possible. +- Confirm the problem and determine the affected versions. +- Audit code to find any potential similar problems. +- Prepare fixes for all releases still under maintenance. These fixes will be + released as quickly as possible. ## Comments on this Policy If you have suggestions on how this process could be improved please submit a -pull request. \ No newline at end of file +pull request.