fix: restore section headers for mandatory capabilities

.github/workflows/cla_assistant.yml

@@ -13,7 +13,7 @@ jobs:
     steps:
       - name: "CLA Assistant"
         if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the Contributor License Agreement and I hereby accept the Terms.') || github.event_name == 'pull_request_target'
-        uses: cla-assistant/github-action@v2.1.3-beta
+        uses: cla-assistant/github-action@v2.3.1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           PERSONAL_ACCESS_TOKEN : ${{ secrets.CLA_BOT_ACCESS_TOKEN }}
@@ -26,4 +26,4 @@ jobs:
           custom-pr-sign-comment: 'I have read the Contributor License Agreement and I hereby accept the Terms.'
           allowlist: user1,bot*
           # edit the path below (if needed) to point to the document containing the CLA that a contributor agrees to
-          path-to-document: 'https://github.com/qir-alliance/qir-spec/blob/main/Contributor_License_Agreement.md' 
+          path-to-document: 'https://github.com/qir-alliance/qir-spec/blob/main/Contributor_License_Agreement.md'

.github/workflows/link_and_spell_check.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     name: "Check spelling, linting and links"
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - 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 &&
@@ -38,11 +38,10 @@ jobs:
       if: ${{ success() || failure() }}
     - name: "Check spelling in changed files"
       # cspell:words streetsidesoftware
-      uses: streetsidesoftware/cspell-action@v1.2.4
+      uses: streetsidesoftware/cspell-action@v6
       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'

.markdownlint.yaml

@@ -0,0 +1,25 @@
+# Reference: https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+
+# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md013.md
+MD013:
+  # Number of characters
+  line_length: 80
+  # Number of characters for headings
+  heading_line_length: 80
+  # Number of characters for code blocks
+  code_block_line_length: 180
+  # Include code blocks
+  code_blocks: true
+  # Include tables
+  tables: false
+  # Include headings
+  headings: true
+  # Strict length checking
+  strict: false
+  # Stern length checking
+  stern: false
+
+# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.33.0/doc/md033.md
+MD033:
+  # Allowed elements
+  allowed_elements: ["br"]

README.md

@@ -18,8 +18,8 @@ documentation to facilitate working with QIR.
 
 ### Asking and Answering Questions
 
-Have a question? This repository is great places to ask questions about QIR and
-the available tools to work with it. Your question will serve as resource to
+Have a question? This repository is a great place to ask questions about QIR and
+the available tools to work with it. Your question will serve as a resource to
 others searching for help. Please file an issue to ask your question
 [here](https://github.com/qir-alliance/qir-spec/issues/new).
 
@@ -51,7 +51,7 @@ have any questions or would like to revoke your consent, please contact
 [[email protected]](mailto:[email protected]).
 
 For more information about the development process for specifications under the
-QIR Alliance, please see the the governance policy available
+QIR Alliance, please see the governance policy available
 [here](https://github.com/qir-alliance/.github/blob/main/Governance.md).
 
 ### Contributing an Implementation
@@ -72,4 +72,4 @@ possible. Thank you for taking the time to contribute.
 This project has adopted the community specification [Code of
 Conduct](https://github.com/qir-alliance/.github/blob/main/Code_of_Conduct.md#contributor-covenant-code-of-conduct).
 Please contact [[email protected]](mailto:[email protected]) for Code of
-Conduct issues or inquires.
+Conduct issues or inquiries.

Resources.md

@@ -17,7 +17,7 @@ about:
 - [A quick introduction to
   LLVM](https://hub.packtpub.com/introducing-llvm-intermediate-representation/)
 - [Gitbook about LLVM-based
-  compilers](https://mapping-high-level-constructs-to-llvm-ir.readthedocs.io/en/latest/README.html)
+  compilers](https://mapping-high-level-constructs-to-llvm-ir.readthedocs.io/en/latest/)
 - [Language reference manual](https://llvm.org/docs/LangRef.html)
 - [Wikipedia entry](https://en.wikipedia.org/wiki/LLVM)
 - [Original publication](https://llvm.org/pubs/2004-01-30-CGO-LLVM.pdf)