Fix broken YML links and add PR template (#1340)

* Fix MD files with broken links

- fixing all broken links
- all YML files are now in capital case

* Add PR template

* remove comments
This commit is contained in:
Vim 2022-02-25 14:39:38 -05:00 committed by GitHub
parent fab828dc66
commit eb03d6cb5f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 29 additions and 7 deletions

View file

@ -0,0 +1,22 @@
# Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
Fixes # (issue number)
## Type of change
- [ ] Bug fix (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)
- [ ] This change requires a documentation update
## Checklist:
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules

View file

@ -1,4 +1,4 @@
name: 'Compile Mermaid in Markdown'
name: 'Compile Mermaid to MD'
on:
push:

View file

@ -1,4 +1,4 @@
name: Deploy Backend staging
name: Deploy Backend Staging
on:
pull_request:
branches: [main]

View file

@ -1,4 +1,4 @@
name: Deploy Frontend staging
name: Deploy Frontend Staging
on:
pull_request:
branches: [main]

View file

@ -1,7 +1,7 @@
# Full command list of cypress github actions:
# https://github.com/cypress-io/github-action#cypress-iogithub-action--
name: End to end tests
name: End to End Tests
on:
# To run tests on the push event of a specific branch:
# push:

View file

@ -1,5 +1,5 @@
[![Staging](https://github.com/usds/justice40-tool/actions/workflows/deploy_staging.yml/badge.svg)](https://github.com/usds/justice40-tool/actions/workflows/deploy_staging.yml)
[![Production](https://github.com/usds/justice40-tool/actions/workflows/deploy_main.yml/badge.svg)](https://github.com/usds/justice40-tool/actions/workflows/deploy_main.yml)
[![Staging](https://github.com/usds/justice40-tool/actions/workflows/deploy_fe_staging.yml/badge.svg)](https://github.com/usds/justice40-tool/actions/workflows/deploy_fe_staging.yml)
[![Production](https://github.com/usds/justice40-tool/actions/workflows/deploy_fe_main.yml/badge.svg)](https://github.com/usds/justice40-tool/actions/workflows/deploy_fe_main.yml)
# Justice40 Client

View file

@ -16,7 +16,7 @@ In the event that you are interested in updating the architecture of our system,
Provided you have already done this, however, and/or would like to make small changes to the diagram itself, please read on!
This diagram was generated from a text-based markdown-like file using [MermaidJS](https://mermaid-js.github.io/) syntax and the [Compile Mermaid Markdown](https://github.com/marketplace/actions/compile-mermaid-markdown) Github Action.
This diagram was generated from a text-based markdown-like file using [MermaidJS](https://mermaid-js.github.io/) syntax and the [Compile Mermaid Markdown](https://github.com/neenjaw/compile-mermaid-markdown-action) Github Action.
To update, consult Mermaid syntax [here](https://mermaid-js.github.io/mermaid/#/flowchart) and update the `architecture.mmd` file.