Enable checks for links, linking and spelling (#3)

bettinaheim · web-flow · commit eedc0eab686b · 2021-11-26T16:15:20.000-08:00
diff --git a/.github/workflows/link_and_spell_check.yml b/.github/workflows/link_and_spell_check.yml
@@ -0,0 +1,50 @@
+on:
+  workflow_dispatch:
+  pull_request:
+    branches:
+    - main
+
+name: "Check spelling, linting and links"
+
+jobs:
+  check-markdown:
+    runs-on: ubuntu-latest
+    name: "Check spelling, linting and links"
+    steps:
+    - uses: actions/checkout@master
+    - run: |
+        wget https://github.com/qir-alliance/.github/archive/refs/heads/main.zip -O clone.zip &&
+        unzip clone.zip && mv .github-main out && rm clone.zip &&
+        mv out/workflow-templates/utils/ utils && rm -r out
+      shell: bash
+    - run: |
+        Get-ChildItem (Join-Path "utils" "problem-matchers") `
+          | ForEach-Object {
+            Write-Host "Adding matcher $_...";
+            Write-Host "::add-matcher::$_";
+          }
+      shell: pwsh
+    - name: markdownlint-cli
+      # cspell:words nosborn
+      uses: nosborn/github-action-markdown-cli@v2.0.0
+      with:
+        files: .
+        config_file: 'utils/md_lint_config.yml'
+    - name: Markdown link check
+      # cspell:words gaurav
+      uses: gaurav-nelson/github-action-markdown-link-check@v1
+      with:
+        use-verbose-mode: 'yes'
+      if: ${{ success() || failure() }}
+    - name: "Checkout"
+      uses: actions/checkout@v2
+    - name: "Check spelling in changed files"
+      # cspell:words streetsidesoftware
+      uses: streetsidesoftware/cspell-action@v1.2.4
+      with:
+        inline: warning
+        # Only warn on spelling errors, since there's likely a lot of false
+        # positives with terminology in quantum computing.
+        strict: false
+        incremental_files_only: true
+        config: 'utils/spelling_allowlist.json'
diff --git a/logo/README.md b/logo/README.md
@@ -1,3 +1,7 @@
 # Usage Rights
 
-The logo(s) and icon(s) in this folder are owned by the QIR Alliance and are available for your download and use royalty-free. By downloading an image, the QIR Alliance grants you, and you accept, a non-exclusive license to use it. All right, title and interest in the image, including the copyright therein, is retained by the QIR Alliance.
+The logo(s) and icon(s) in this folder are owned by the QIR Alliance and are
+available for your download and use royalty-free. By downloading an image, the
+QIR Alliance grants you, and you accept, a non-exclusive license to use it. All
+right, title and interest in the image, including the copyright therein, is
+retained by the QIR Alliance.
diff --git a/minutes/sc-meeting-2021-10.md b/minutes/sc-meeting-2021-10.md
@@ -25,39 +25,39 @@ Fabrice Franchon, Kalan Snyder, Thien Nguyen, Tom Lubinski, Pauline Jordan
 ## Key decisions (all voted unanimously)
 
 - Logo:
-    - We are choosing Option A (as referred in attached presentation).
-    - Pauline will investigate some variants to possibly make the “I” more
-      obvious but we did not seem to consider this as blocking. Fabrice to share
-      back the additional options.
+  - We are choosing Option A (as referred in attached presentation).
+  - Pauline will investigate some variants to possibly make the “I” more
+    obvious but we did not seem to consider this as blocking. Fabrice to share
+    back the additional options.
 - GitHub
-    - Steering Committee will appoint maintainers of code who will have
-      flexibility to maintain while the steering committee observes
-    - Steering Committee members have admin rights.
-    - There will be one repo per spec, and profiles will be sub-folders
-        - https://github.com/qir-alliance for the organization
-        - https://github.com/qir-alliance/qir-spec for the QIR specification
+  - Steering Committee will appoint maintainers of code who will have
+    flexibility to maintain while the steering committee observes
+  - Steering Committee members have admin rights.
+  - There will be one repo per spec, and profiles will be sub-folders
+    - https://github.com/qir-alliance for the organization
+    - https://github.com/qir-alliance/qir-spec for the QIR specification
 - Specification
-    - We will check-in the current version of the specification
-    - Additional changes such as callable values support and adding C APIs will
-      be added as part of the normal contribution process
+  - We will check-in the current version of the specification
+  - Additional changes such as callable values support and adding C APIs will
+    be added as part of the normal contribution process
 - Announcements and Press Releases
-    - Linux Foundation will announce to its members (Project notice) the
-      formation of the Alliance within the next 2 business days
-    - A formal press release will be published in November based on inputs from
-      all members.
+  - Linux Foundation will announce to its members (Project notice) the
+    formation of the Alliance within the next 2 business days
+  - A formal press release will be published in November based on inputs from
+    all members.
 - Chair
-    - Steering Committee unanimously elected Bettina Heim as Chair of the QIR
-      Alliance Steering Committee
+  - Steering Committee unanimously elected Bettina Heim as Chair of the QIR
+    Alliance Steering Committee
 - Steering Committee meetings
-    - Monthly formal cadence augmented by ad-hoc meetings and discussions
-    - Teams will be the main meeting and communication mechanism among steering
-      committee members
-    - Keep Steering Committee meetings closed until the most public announcement
-      of the creation of QIR Alliance (right before Q2B). We will likely open-up
-      after that, while making sure there is a proper organization to receive
-      input from non-steering committee members.
+  - Monthly formal cadence augmented by ad-hoc meetings and discussions
+  - Teams will be the main meeting and communication mechanism among steering
+    committee members
+  - Keep Steering Committee meetings closed until the most public announcement
+    of the creation of QIR Alliance (right before Q2B). We will likely open-up
+    after that, while making sure there is a proper organization to receive
+    input from non-steering committee members.
 
-##  Follow-ups / Action items
+## Follow-ups / Action items
 
 - Fabrice to identify if https://github.com/qira can be obtained from their
   current owners.
@@ -70,4 +70,4 @@ Fabrice Franchon, Kalan Snyder, Thien Nguyen, Tom Lubinski, Pauline Jordan
 ## Additional notes
 
 - GitHub
-    - Linux Foundation needs to be an owner (but not an administrator)
+  - Linux Foundation needs to be an owner (but not an administrator)
diff --git a/minutes/sc-meeting-2021-11.md b/minutes/sc-meeting-2021-11.md
@@ -9,8 +9,8 @@ Kalan Snyder, Thien Nguyen, Tom Lubinski, Travis Humble, Seth Newberry (Guest)
 - Proposals for a discussion and vote on steering committee attendance
 - Admin tasks and follow-ups status
 - Q2B attendance and abstract draft
-- 3 requests for repos under qir-alliance
-need formal approval and confirm level of autonomy of maintainers
+- 3 requests for repos under qir-alliance need formal approval and confirm level
+  of autonomy of maintainers
   - QCOR (ORNL)
   - PyQIR (MS)
   - QAT (MS)
@@ -26,52 +26,60 @@ need formal approval and confirm level of autonomy of maintainers
 
 - Steering Committee members can invite Subject Matter Experts, including if
   they are not members.
-    - Alex McCaskey to be invited to subsequent meetings
-    - Communication:<br/>
-      > *"The steering committee meets once a month. The meetings are not open to the
-      public at this time, but minutes will be published on [link]. The steering
-      committee may invite domain experts and repository maintainers to join the
-      discussions. Please reach out to [email] if you would like to propose a topic
-      for consideration and/or would like to volunteer your time and expertise."*
+  - Alex McCaskey to be invited to subsequent meetings
+  - Communication:<br/>
+    > *"The steering committee meets once a month. The meetings are not open to
+    the public at this time, but minutes will be published on [link]. The
+    steering committee may invite domain experts and repository maintainers to
+    join the discussions. Please reach out to [email] if you would like to
+    propose a topic for consideration and/or would like to volunteer your time
+    and expertise."*
 - Repos maintainers can attend steering committee meetings
 - Q2B presentation
   - Title and abstract: <br/>
-    >*“**Empowering heterogeneous quantum computing of today and tomorrow with QIR**<br/>
+    >*“**Empowering heterogeneous quantum computing of today and tomorrow with
+    >QIR**<br/>
     Quantum computing systems and languages evolve at a fast pace, promising
     exciting advances in how classical and quantum computations can interact at
     the hardware level. To provide interoperability between different frameworks
     and accelerate progress for all parties, it is imperative for the ecosystem
     to develop and share a forward-looking quantum intermediate representation
     (QIR) that leverages state of the art compiler technology capable of
     supporting the full variety of heterogenous quantum processors. <br/>
-    The QIR Alliance is a joint effort to develop an intermediate representation that
-    enables full interoperability within the quantum ecosystem, and provides a
-    holistic program representation suitable for taking full advantage of the
-    unique and distinct capabilities of present and future quantum processors. <br/>
-    In this session we will explore critical advances based on three examples that
-    illustrate the novel opportunities for a spectrum of use cases arising from this effort.”*
+    The QIR Alliance is a joint effort to develop an intermediate representation
+    that enables full interoperability within the quantum ecosystem, and
+    provides a holistic program representation suitable for taking full
+    advantage of the unique and distinct capabilities of present and future
+    quantum processors. <br/>
+    In this session we will explore critical advances based on three examples
+    that illustrate the novel opportunities for a spectrum of use cases arising
+    from this effort.”*
 - Mode of operation and communication of code repositories
-    - Addition of the following repos: PyQIR, QAT, QCOR
-    - Requirements for code repositories:
-      >*"Anyone can ask to add an open-source repository under the QIR Alliance,
-      and the steering committee will approve or deny the request depending on
-      whether the minimum requirements as outlined below are satisfied. The
-      steering committee may also solicit such contributions. <br/>
-      > For code repositories under the QIR Alliance,
-      >  - At least two maintainers need to be designated for the repository,
-          and a way to contact the maintainers should be shared with the
-          steering committee.
-      >  - The repository is either actively maintained by the maintainers or the
-          repository is archived.
-      >  - The code of conduct aligns in spirit with the code of conduct of the
-          broader org.
-      >  - The project should be related in content to the scope defined for the
-          QIR Alliance.
-      >  - All code should be licensed under MIT license, and
-          contributors to the repository must accept a CLA defined by the maintainers.
-          <br/><br/>
-
-      > The QIR Alliance will reach out to the maintainers if a repository no longer satisfies these criteria to reach an agreement and resolve the situation. If the maintainers cannot be reached or are unable or unwilling to take action, the QIR Alliance reserves the right to archive the repository."*
+  - Addition of the following repos: PyQIR, QAT, QCOR
+  - Requirements for code repositories:
+    >*"Anyone can ask to add an open-source repository under the QIR Alliance,
+    and the steering committee will approve or deny the request depending on
+    whether the minimum requirements as outlined below are satisfied. The
+    steering committee may also solicit such contributions.* <br/>
+    >*For code repositories under the QIR Alliance,*
+    >
+    > - *At least two maintainers need to be designated for the repository, and
+            a way to contact the maintainers should be shared with the steering
+            committee.*
+    > - *The repository is either actively maintained by the maintainers or the
+            repository is archived.*
+    > - *The code of conduct aligns in spirit with the code of conduct of the
+            broader org.*
+    > - *The project should be related in content to the scope defined for the
+            QIR Alliance.*
+    > - *All code should be licensed under MIT license, and contributors to the
+            repository must accept a CLA defined by the maintainers.* <br/><br/>
+    >
+    > *The QIR Alliance will reach out to the maintainers if a repository no
+      longer satisfies these criteria to reach an agreement and resolve the
+      situation. If the maintainers cannot be reached or are unable or unwilling
+      to take action, the QIR Alliance reserves the right to archive the
+      repository."*
 
 ## Additional notes
 
@@ -83,17 +91,17 @@ need formal approval and confirm level of autonomy of maintainers
 - JDF needs a FAQ that they can use to help answer questions from parties
   interested in QIR Alliance (some Platinum members already expressed interest).
 - Attending Q2B:
-    - Honeywell: Pete Campora
-    - Microsoft: Bettina Heim, Chris Granada, Fabrice Frachon, Viktor Veis
-    - ORNL: Not attending
-    - QCI: Tom Lubinski
-    - Rigetti: Kalan Snyder
+  - Honeywell: Pete Campora
+  - Microsoft: Bettina Heim, Chris Granada, Fabrice Frachon, Viktor Veis
+  - ORNL: Not attending
+  - QCI: Tom Lubinski
+  - Rigetti: Kalan Snyder
 - Adding external code:
-    - Do not accept anything that contain something like a GPL license as it
-      relicenses the entire code.
-    - Should be ok to add copyrighted materials (Seth following-up)
+  - Do not accept anything that contain something like a GPL license as it
+    relicenses the entire code.
+  - Should be ok to add copyrighted materials (Seth following-up)
 - Press release
-    - Members will be amplifying on their social channels but no specific blog
-      planned.
+  - Members will be amplifying on their social channels but no specific blog
+    planned.
 - We should create an Info@ and legal@ alias to direct interest (Fabrice to
   investigate best option).
diff --git a/workflow-templates/utils/md_lint_config.yml b/workflow-templates/utils/md_lint_config.yml
@@ -22,4 +22,8 @@ no-duplicate-heading:
 
 # Allow selective inline markdown
 no-inline-html:
-  allowed_elements: [br]
+  allowed_elements: [br]
+
+# Allow exclamation mark and question marks in headings
+MD026:
+  punctuation: ".,;:。，；：！"
