mirror of
https://github.com/DOI-DO/j40-cejst-2.git
synced 2025-02-22 09:41:26 -08:00
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:
parent
fab828dc66
commit
eb03d6cb5f
7 changed files with 29 additions and 7 deletions
22
.github/ISSUE_TEMPLATE/pull_request_template.md
vendored
Normal file
22
.github/ISSUE_TEMPLATE/pull_request_template.md
vendored
Normal 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
|
2
.github/workflows/compile_mermaid.yml
vendored
2
.github/workflows/compile_mermaid.yml
vendored
|
@ -1,4 +1,4 @@
|
||||||
name: 'Compile Mermaid in Markdown'
|
name: 'Compile Mermaid to MD'
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
|
2
.github/workflows/deploy_be_staging.yml
vendored
2
.github/workflows/deploy_be_staging.yml
vendored
|
@ -1,4 +1,4 @@
|
||||||
name: Deploy Backend staging
|
name: Deploy Backend Staging
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [main]
|
branches: [main]
|
||||||
|
|
2
.github/workflows/deploy_fe_staging.yml
vendored
2
.github/workflows/deploy_fe_staging.yml
vendored
|
@ -1,4 +1,4 @@
|
||||||
name: Deploy Frontend staging
|
name: Deploy Frontend Staging
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
branches: [main]
|
branches: [main]
|
||||||
|
|
2
.github/workflows/e2e.yml
vendored
2
.github/workflows/e2e.yml
vendored
|
@ -1,7 +1,7 @@
|
||||||
# Full command list of cypress github actions:
|
# Full command list of cypress github actions:
|
||||||
# https://github.com/cypress-io/github-action#cypress-iogithub-action--
|
# https://github.com/cypress-io/github-action#cypress-iogithub-action--
|
||||||
|
|
||||||
name: End to end tests
|
name: End to End Tests
|
||||||
on:
|
on:
|
||||||
# To run tests on the push event of a specific branch:
|
# To run tests on the push event of a specific branch:
|
||||||
# push:
|
# push:
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[](https://github.com/usds/justice40-tool/actions/workflows/deploy_staging.yml)
|
[](https://github.com/usds/justice40-tool/actions/workflows/deploy_fe_staging.yml)
|
||||||
[](https://github.com/usds/justice40-tool/actions/workflows/deploy_main.yml)
|
[](https://github.com/usds/justice40-tool/actions/workflows/deploy_fe_main.yml)
|
||||||
|
|
||||||
# Justice40 Client
|
# Justice40 Client
|
||||||
|
|
||||||
|
|
|
@ -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!
|
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.
|
To update, consult Mermaid syntax [here](https://mermaid-js.github.io/mermaid/#/flowchart) and update the `architecture.mmd` file.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue