Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Turn directions in PR template into comments #1707

Merged
merged 1 commit into from
Mar 3, 2021
Merged

Conversation

davidmrdavid
Copy link
Contributor

@davidmrdavid davidmrdavid commented Mar 3, 2021

<-- Start the PR description with some context for the change. -->
Currently, the directions in the PR template aren't proper markdown comments, so they need to either be removed from every PR, or manually turned into comments so they won't render.

As an example, see above 👀^

This PR simply turns those directions into comments so that the instructions can be preserved while editing the text without the need to modify them further.

Pull request checklist

  • My changes do not require documentation changes
    • Otherwise: Documentation PR is ready to merge and referenced in pending_docs.md
  • My changes should not be added to the release notes for the next release
    • Otherwise: I've added my notes to release_notes.md
  • My changes do not need to be backported to a previous version
    • Otherwise: Backport tracked by issue/PR #issue_or_pr
  • I have added all required tests (Unit tests, E2E tests)

Copy link
Contributor

@ConnorMcMahon ConnorMcMahon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fixup here!

@davidmrdavid davidmrdavid merged commit 6fd65a8 into dev Mar 3, 2021
@davidmrdavid davidmrdavid deleted the dajusto/pr-template branch March 3, 2021 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants