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

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?plain=1#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>
pull/1974/head^2
Anton Gilgur 2023-04-22 01:53:02 -04:00 committed by GitHub
parent 29b753057b
commit 429b474a4f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions

View File

@ -1,6 +1,8 @@
<!--
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.
-->
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).
* [ ] 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. -->