make markdown pass the lint

TBD54566975 · Nov 9, 2023 · ea535cd · ea535cd
1 parent 3d69df7
commit ea535cd
Show file tree

Hide file tree

Showing 10 changed files with 163 additions and 138 deletions.
diff --git a/.github/_ISSUE_TEMPLATE/bug-report.md b/.github/_ISSUE_TEMPLATE/bug-report.md
@@ -12,6 +12,7 @@ assignees: add codeowner's @name here
 
 **To Reproduce:**
 *Steps to reproduce the behavior:*
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,8 +25,9 @@ assignees: add codeowner's @name here
 *If applicable, add screenshots, output log and/or other documentation to help explain your problem.*
 
 **Environment (please complete the following information):**
- - OS: [ex: iOS]
- - Version 
+
+- OS: [ex: iOS]
+- Version
 
 **Additional context**
 Add any other context that you feel is relevant about the problem here.
diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml
@@ -0,0 +1,2 @@
+config:
+  line-length: false
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -5,7 +5,6 @@ TBD builds infrastructure for the next wave of innovation in financial services
 
 The code of conduct below reflects the expectations for ourselves and for our community.
 
-
 ## Our Pledge
 
 We as members, contributors, and leaders pledge to make participation in our
@@ -90,7 +89,7 @@ actions.
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
-like social media and forums. 
+like social media and forums.
 
 Although this list cannot be exhaustive, we explicitly honor diversity in age, culture, ethnicity, gender identity or expression, language, national origin, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, and technical ability. We will not tolerate discrimination based on any of the protected characteristics above, including participants with disabilities.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,9 @@
-# Contribution Guide 
+# Contribution Guide
+<!-- markdownlint-disable -->
 
 There are many ways to be an open source contributor, and we're here to help you on your way! You may:
 
-* Propose ideas in our 
+* Propose ideas in our
   [discord](https://discord.gg/tbd)
 * Raise an issue or feature request in our [issue tracker](https://github.com/TBD54566975/web5-spec/issues)
 * Help another contributor with one of their questions, or a code review
@@ -13,7 +14,7 @@ This guide is for you.
 
 ## Development Prerequisites
 
-___***UPDATE TABLE OF PROJECT DEPS AND INSTALLATION NOTES***___
+___*__UPDATE TABLE OF PROJECT DEPS AND INSTALLATION NOTES__*___
 
 | Requirement | Tested Version | Installation Instructions                            |
 |-------------|----------------|------------------------------------------------------|
@@ -23,7 +24,7 @@ ___***UPDATE TABLE OF PROJECT DEPS AND INSTALLATION NOTES***___
 
 ### Go
 
-This project is written in Go, a modern, open source programming language. 
+This project is written in Go, a modern, open source programming language.
 
 You may verify your `go` installation via the terminal:
 
@@ -37,6 +38,7 @@ If you do not have go, we recommend installing it by:
 #### MacOS
 
 ##### Homebrew
+
 ```
 $> brew install go
 ```
@@ -73,13 +75,13 @@ Installation instructions are on the [Magefile home page](https://magefile.org/)
 
 ### Java
 
-This project is written in Java, a typesafe, compiled programming language. 
+This project is written in Java, a typesafe, compiled programming language.
 
 You may verify your `java` installation via the terminal by running `java -version`.
 
-If you do not have Java, we recommend installing it 
-via [SDKMan](https://sdkman.io/install). This is a project which will allow you 
-to easily install the Java Development Kit (JDK), runtime (JRE), and related frameworks, 
+If you do not have Java, we recommend installing it
+via [SDKMan](https://sdkman.io/install). This is a project which will allow you
+to easily install the Java Development Kit (JDK), runtime (JRE), and related frameworks,
 build tools, and runtimes.
 
 After you've installed SDKMan, you may install Java:
@@ -122,11 +124,13 @@ $> mage build
 ## Build (Java / Gradle)
 
 ### macOS / Linux
+
 ```shell
 $> ./gradlew build
 ```
 
 ### Windows
+
 ```shell
 $> gradlew.bat build
 ```
@@ -140,11 +144,13 @@ $> mage test
 ## Test (Java / Gradle)
 
 ### macOS / Linux
+
 ```shell
 $> ./gradlew test
 ```
 
 ### Windows
+
 ```shell
 $> gradlew.bat test
 ```
@@ -164,7 +170,7 @@ $> ./gradlew clean build test
 
 ### Issues
 
-Anyone from the community is welcome (and encouraged!) to raise issues via 
+Anyone from the community is welcome (and encouraged!) to raise issues via
 [GitHub Issues](https://github.com/TBD54566975/web5-spec/issues).
 
 ### Discussions
@@ -179,34 +185,34 @@ Build and Test cycles are run on every commit to every branch on [GitHub Actions
 
 ## Contribution
 
-We review contributions to the codebase via GitHub's Pull Request mechanism. We have 
-the following guidelines to ease your experience and help our leads respond quickly 
+We review contributions to the codebase via GitHub's Pull Request mechanism. We have
+the following guidelines to ease your experience and help our leads respond quickly
 to your valuable work:
 
-* Start by proposing a change either in Issues (most appropriate for small 
-  change requests or bug fixes) or in Discussions (most appropriate for design 
-  and architecture considerations, proposing a new feature, or where you'd 
+* Start by proposing a change either in Issues (most appropriate for small
+  change requests or bug fixes) or in Discussions (most appropriate for design
+  and architecture considerations, proposing a new feature, or where you'd
   like insight and feedback)
-* Cultivate consensus around your ideas; the project leads will help you 
-  pre-flight how beneficial the proposal might be to the project. Developing early 
-  buy-in will help others understand what you're looking to do, and give you a 
-  greater chance of your contributions making it into the codebase! No one wants to 
+* Cultivate consensus around your ideas; the project leads will help you
+  pre-flight how beneficial the proposal might be to the project. Developing early
+  buy-in will help others understand what you're looking to do, and give you a
+  greater chance of your contributions making it into the codebase! No one wants to
   see work done in an area that's unlikely to be incorporated into the codebase.
 * Fork the repo into your own namespace/remote
-* Work in a dedicated feature branch. Atlassian wrote a great 
+* Work in a dedicated feature branch. Atlassian wrote a great
   [description of this workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow)
 * When you're ready to offer your work to the project, first:
-* Squash your commits into a single one (or an appropriate small number of commits), and 
-  rebase atop the upstream `main` branch. This will limit the potential for merge 
-  conflicts during review, and helps keep the audit trail clean. A good writeup for 
-  how this is done is 
-  [here](https://medium.com/@slamflipstrom/a-beginners-guide-to-squashing-commits-with-git-rebase-8185cf6e62ec), and if you're 
-  having trouble - feel free to ask a member or the community for help or leave the commits as-is, and flag that you'd like 
+* Squash your commits into a single one (or an appropriate small number of commits), and
+  rebase atop the upstream `main` branch. This will limit the potential for merge
+  conflicts during review, and helps keep the audit trail clean. A good writeup for
+  how this is done is
+  [here](https://medium.com/@slamflipstrom/a-beginners-guide-to-squashing-commits-with-git-rebase-8185cf6e62ec), and if you're
+  having trouble - feel free to ask a member or the community for help or leave the commits as-is, and flag that you'd like
   rebasing assistance in your PR! We're here to support you.
 * Open a PR in the project to bring in the code from your feature branch.
-* The maintainers noted in the `CODEOWNERS` file will review your PR and optionally 
+* The maintainers noted in the `CODEOWNERS` file will review your PR and optionally
   open a discussion about its contents before moving forward.
 * Remain responsive to follow-up questions, be open to making requested changes, and...
   You're a contributor!
-* And remember to respect everyone in our global development community. Guidelines 
+* And remember to respect everyone in our global development community. Guidelines
   are established in our `CODE_OF_CONDUCT.md`.
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -27,7 +27,7 @@ Maintainers have write access to GitHub repositories and act as project administ
 * Commit access to their project's repositories
 * Write access to continuous integration (CI) jobs
 
-Both maintainers and non-maintainers may propose changes to 
+Both maintainers and non-maintainers may propose changes to
 source code. The mechanism to propose such a change is a GitHub pull request. Maintainers review and merge (_land_) pull requests.
 
 If a maintainer opposes a proposed change, then the change cannot land. The exception is if the Governance Committee (GC) votes to approve the change despite the opposition. Usually, involving the GC is unnecessary.