format markdown

Author: justinmchase

Diff for: .github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -8,10 +8,12 @@ assignees: ""
 
 ## Bug Report
 
-Thanks for reporting an issue, please review the task list below before submitting the
-issue. Your issue report will be closed if the issue is incomplete and the below tasks not completed.
+Thanks for reporting an issue, please review the task list below before
+submitting the issue. Your issue report will be closed if the issue is
+incomplete and the below tasks not completed.
 
 ## Task List
+
 _Put an `x` in the boxes that apply_
 
 - [ ] Steps to reproduce provided
@@ -33,7 +35,8 @@ Tell us what happens instead
 
 ## Steps to Reproduce
 
-Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application.
+Please explain the steps required to duplicate the issue, especially if you are
+able to provide a sample application.
 
 1. TODO
 2. TODO
@@ -49,4 +52,5 @@ insert short code snippets here
 
 ## Further comments
 
-List any other information that is relevant to your issue. Related issues, suggestions on how to fix, Stack Overflow links, forum links, etc.
+List any other information that is relevant to your issue. Related issues,
+suggestions on how to fix, Stack Overflow links, forum links, etc.

Diff for: .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -8,11 +8,12 @@ assignees: ""
 
 ## Feature Request
 
-Thanks for showing an interest in continuing to grow this product! Please review the task list below
-before submitting the request. Your feature request will be closed if the information is incomplete
-and the below tasks are not completed.
+Thanks for showing an interest in continuing to grow this product! Please review
+the task list below before submitting the request. Your feature request will be
+closed if the information is incomplete and the below tasks are not completed.
 
 ## Task List
+
 _Put an `x` in the boxes that apply_
 
 - [ ] Describe the feature being requested
@@ -21,27 +22,29 @@ _Put an `x` in the boxes that apply_
 
 **If the feature request is approved, would you be willing to submit a PR?**
 _(Help can be provided if you need assistance submitting a PR)_
+
 - [ ] Yes
 - [ ] No
 
 ## Describe the Feature Request
 
-Please provide a clear and concise description of what the feature request is. Please include if your
-feature request is related to a problem.
+Please provide a clear and concise description of what the feature request is.
+Please include if your feature request is related to a problem.
 
 ## Describe Preferred Solution
 
 Provide a clear and concise description of what you want to happen.
 
 ## Describe Alternatives
 
-If applicable, please provide a clear and concise description of any alternative solutions or features
-you've considered.
+If applicable, please provide a clear and concise description of any alternative
+solutions or features you've considered.
 
 ## Related Code
 
-If you are able to illustrate the new feature request with an example, please provide it here.
+If you are able to illustrate the new feature request with an example, please
+provide it here.
 
 ## Further comments
 
-Any other additional comments on the new feature can be added here.
+Any other additional comments on the new feature can be added here.

Diff for: .github/PULL_REQUEST_TEMPLATE.md

@@ -1,25 +1,35 @@
 ## Proposed changes
 
-Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
+Describe the big picture of your changes here to communicate to the maintainers
+why we should accept this pull request. If it fixes a bug or resolves a feature
+request, be sure to link to that issue.
 
 ## Types of changes
 
-What types of changes does your code introduce?
-_Put an `x` in the boxes that apply_
+What types of changes does your code introduce? _Put an `x` in the boxes that
+apply_
 
 - [ ] Bugfix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Breaking change (fix or feature that would cause existing functionality to
+      not work as expected)
 
 ## Checklist
 
-_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
+_Put an `x` in the boxes that apply. You can also fill these out after creating
+the PR. If you're unsure about any of them, don't hesitate to ask. We're here to
+help! This is simply a reminder of what we are going to look for before merging
+your code._
 
-- [ ] I have read the [CONTRIBUTING](https://github.com/Optum/oss-template/blob/main/CONTRIBUTING.md) doc
+- [ ] I have read the
+      [CONTRIBUTING](https://github.com/Optum/oss-template/blob/main/CONTRIBUTING.md)
+      doc
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] I have added necessary documentation (if appropriate)
 - [ ] Any dependent changes have been merged and published in downstream modules
 
 ## Further comments
 
-If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...
+If this is a relatively large or complex change, kick off the discussion by
+explaining why you chose the solution you did and what alternatives you
+considered, etc...

Diff for: CODE_OF_CONDUCT.md

@@ -5,30 +5,30 @@
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
 our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
 
 ## Our Standards
 
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
   address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Our Responsibilities
@@ -37,11 +37,11 @@ Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
 
 ## Scope
 
@@ -58,18 +58,19 @@ Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported by contacting the project team at [[email protected]][email]. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
+obligated to maintain confidentiality with regard to the reporter of an
+incident. Further details of specific enforcement policies may be posted
+separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
 
 [homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/4/
-[email]: mailto:[email protected]
+[email]: mailto:[email protected]

Diff for: CONTRIBUTING.md

@@ -1,54 +1,90 @@
 # Contribution Guidelines
 
-Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. Please also review our [Contributor License Agreement ("CLA")](INDIVIDUAL_CONTRIBUTOR_LICENSE.md) prior to submitting changes to the project.  You will need to attest to this agreement following the instructions in the [Paperwork for Pull Requests](#paperwork-for-pull-requests) section below.
+Please note that this project is released with a
+[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this
+project you agree to abide by its terms. Please also review our
+[Contributor License Agreement ("CLA")](INDIVIDUAL_CONTRIBUTOR_LICENSE.md) prior
+to submitting changes to the project. You will need to attest to this agreement
+following the instructions in the
+[Paperwork for Pull Requests](#paperwork-for-pull-requests) section below.
 
 ---
 
 # How to Contribute
 
-Now that we have the disclaimer out of the way, let's get into how you can be a part of our project. There are many different ways to contribute.
+Now that we have the disclaimer out of the way, let's get into how you can be a
+part of our project. There are many different ways to contribute.
 
 ## Issues
 
-We track our work using Issues in GitHub. Feel free to open up your own issue to point out areas for improvement or to suggest your own new experiment. If you are comfortable with signing the waiver linked above and contributing code or documentation, grab your own issue and start working.
+We track our work using Issues in GitHub. Feel free to open up your own issue to
+point out areas for improvement or to suggest your own new experiment. If you
+are comfortable with signing the waiver linked above and contributing code or
+documentation, grab your own issue and start working.
 
 ## Coding Standards
 
 We have some general guidelines towards contributing to this project.
 
 ### Languages
 
-*Lua*
+_Lua_
 
 ## Pull Requests
 
-If you've gotten as far as reading this section, then thank you for your suggestions.
+If you've gotten as far as reading this section, then thank you for your
+suggestions.
 
 ## Paperwork for Pull Requests
 
-* Please read this guide and make sure you agree with our [Contributor License Agreement ("CLA")](INDIVIDUAL_CONTRIBUTOR_LICENSE.md).
-* Make sure git knows your name and email address:
-   ```
-   $ git config user.name "J. Random User"
-   $ git config user.email "[email protected]"
-   ```
->The name and email address must be valid as we cannot accept anonymous contributions.
-* Write good commit messages.
-> Concise commit messages that describe your changes help us better understand your contributions.
-* The first time you open a pull request in this repository, you will see a comment on your PR with a link that will allow you to sign our Contributor License Agreement (CLA) if necessary.
-> The link will take you to a page that allows you to view our CLA.  You will need to click the `Sign in with GitHub to agree button` and authorize the cla-assistant application to access the email addresses associated with your GitHub account.  Agreeing to the CLA is also considered to be an attestation that you either wrote or have the rights to contribute the code.  All committers to the PR branch will be required to sign the CLA, but you will only need to sign once.  This CLA applies to all repositories in the Optum org.
+- Please read this guide and make sure you agree with our
+  [Contributor License Agreement ("CLA")](INDIVIDUAL_CONTRIBUTOR_LICENSE.md).
+- Make sure git knows your name and email address:
+  ```
+  $ git config user.name "J. Random User"
+  $ git config user.email "[email protected]"
+  ```
+
+> The name and email address must be valid as we cannot accept anonymous
+> contributions.
+
+- Write good commit messages.
+
+> Concise commit messages that describe your changes help us better understand
+> your contributions.
+
+- The first time you open a pull request in this repository, you will see a
+  comment on your PR with a link that will allow you to sign our Contributor
+  License Agreement (CLA) if necessary.
+
+> The link will take you to a page that allows you to view our CLA. You will
+> need to click the `Sign in with GitHub to agree button` and authorize the
+> cla-assistant application to access the email addresses associated with your
+> GitHub account. Agreeing to the CLA is also considered to be an attestation
+> that you either wrote or have the rights to contribute the code. All
+> committers to the PR branch will be required to sign the CLA, but you will
+> only need to sign once. This CLA applies to all repositories in the Optum org.
 
 ## General Guidelines
 
 Ensure your pull request (PR) adheres to the following guidelines:
 
-* Try to make the name concise and descriptive.
-* Give a good description of the change being made. Since this is very subjective, see the [Updating Your Pull Request (PR)](#updating-your-pull-request-pr) section below for further details.
-* Every pull request should be associated with one or more issues. If no issue exists yet, please create your own.
-* Make sure that all applicable issues are mentioned somewhere in the PR description. This can be done by typing # to bring up a list of issues.
+- Try to make the name concise and descriptive.
+- Give a good description of the change being made. Since this is very
+  subjective, see the
+  [Updating Your Pull Request (PR)](#updating-your-pull-request-pr) section
+  below for further details.
+- Every pull request should be associated with one or more issues. If no issue
+  exists yet, please create your own.
+- Make sure that all applicable issues are mentioned somewhere in the PR
+  description. This can be done by typing # to bring up a list of issues.
 
 ### Updating Your Pull Request (PR)
 
-A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. This applies to both the content documented in the PR and the changed contained within the branch being merged. There's no need to open a new PR. Just edit the existing one.
+A lot of times, making a PR adhere to the standards above can be difficult. If
+the maintainers notice anything that we'd like changed, we'll ask you to edit
+your PR before we merge it. This applies to both the content documented in the
+PR and the changed contained within the branch being merged. There's no need to
+open a new PR. Just edit the existing one.
 
-[email]: mailto:[email protected]
+[email]: mailto:[email protected]