diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..7f49765ad --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,44 @@ +FILL IN THE PR DESCRIPTION HERE + +FIX #xxxx (*link existing issues this PR will resolve*) + +**BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE** + +--- + +
+ + PR Checklist (Click to Expand) + +

Thank you for your contribution to production-stack! Before submitting the pull request, please ensure the PR meets the following criteria. This helps us maintain the code quality and improve the efficiency of the review process.

+ +

PR Title and Classification

+

Please try to classify PRs for easy understanding of the type of changes. The PR title is prefixed appropriately to indicate the type of change. Please use one of the following:

+ +

Note: If the PR spans more than one category, please include all relevant prefixes.

+ +

Code Quality

+ +

The PR need to meet the following code quality standards:

+ + + +

DCO and Signed-off-by

+

When contributing changes to this project, you must agree to the DCO. Commits must include a Signed-off-by: header which certifies agreement with the terms of the DCO.

+

Using -s with git commit will automatically add this header.

+ +

What to Expect for the Reviews

+ +We aim to address all PRs in a timely manner. If no one reviews your PR within 5 days, please @-mention one of YuhanLiu11 +, Shaoting-Feng or ApostaC. diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0b1c60e17..3ee9ee9e3 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -41,6 +41,7 @@ repos: rev: v0.44.0 hooks: - id: markdownlint + exclude: ".github/PULL_REQUEST_TEMPLATE.md" - repo: https://github.com/codespell-project/codespell rev: v2.4.1 hooks: