DevFW-CICD/argocd-helm
16
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(github): comment out notational pieces of PR template (#1969)

Browse source 
github: comment out notational pieces of PR template

- the DCO and publishing sentences are not filled out during PRs
  and are purely notational
  - comment them out with HTML comments, as is common practice
    - example from a repo I maintain: f6db59613a/.github/issue_template.md (L2)
      - I copied that from other repos too
  - these comments are still visible to the PR author, just not visible
    when rendered, keeping the PR more concise

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Co-authored-by: Marco Kilchhofer <mkilchhofer@users.noreply.github.com>
Signed-off-by: Tal Yitzhak <talyi@jfrog.com>
This commit is contained in:
Anton Gilgur 2023-04-22 01:53:02 -04:00 committed by Tal Yitzhak
parent 29b753057b
commit d4b3e266cc
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/pull_request_template.md vendored
View file

@ -1,6 +1,8 @@
<!--
Note on DCO: Note on DCO:
If the DCO action in the integration test fails, one or more of your commits are not signed off. Please click on the *Details* link next to the DCO action for instructions on how to resolve this. If the DCO action in the integration test fails, one or more of your commits are not signed off. Please click on the *Details* link next to the DCO action for instructions on how to resolve this.
-->
Checklist: Checklist:
@ -11,4 +13,4 @@ Checklist:
* [ ] I have signed off all my commits as required by [DCO](https://github.com/argoproj/argoproj/blob/master/community/CONTRIBUTING.md). * [ ] I have signed off all my commits as required by [DCO](https://github.com/argoproj/argoproj/blob/master/community/CONTRIBUTING.md).
* [ ] My build is green ([troubleshooting builds](https://argo-cd.readthedocs.io/en/stable/developer-guide/ci/)). * [ ] My build is green ([troubleshooting builds](https://argo-cd.readthedocs.io/en/stable/developer-guide/ci/)).
Changes are automatically published when merged to `main`. They are not published on branches. <!-- Changes are automatically published when merged to `main`. They are not published on branches. -->