From 22b07acb524d29fe980f16f8105f613adea83926 Mon Sep 17 00:00:00 2001 From: Anna Petrasova Date: Mon, 26 Aug 2024 12:31:16 -0400 Subject: [PATCH] contributing: add PR template (#4207) Also exclude MD041 globally --- .../pull_request_template.md | 32 +++++++++++++++++++ .markdownlint.yml | 2 ++ 2 files changed, 34 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/pull_request_template.md diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md new file mode 100644 index 00000000000..b9d45627ffc --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -0,0 +1,32 @@ +## Description + + +## Motivation and context + + + +## How has this been tested? + + +## Screenshots (if appropriate) + +## Types of changes + + +- [ ] 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 before) + +## Checklist + + +- [ ] PR title provides summary of the changes and starts with one of the +[pre-defined prefixes](../../utils/release.yml) + + +- [ ] My code follows the [code style](../../doc/development/style_guide.md) +of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have added tests to cover my changes. diff --git a/.markdownlint.yml b/.markdownlint.yml index e14a39a2289..44c5b53c8be 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -4,3 +4,5 @@ default: true # Fix any fixable errors (depending on the markdownlint wrapper tool used) fix: true + +MD041: false # first-line-h1