From ca47dae69904a369e74cde4cd5323fc576cfeb2f Mon Sep 17 00:00:00 2001 From: zhanghongtong Date: Mon, 22 Feb 2021 15:32:14 +0800 Subject: [PATCH] docs: format contributing --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- CONTRIBUTING.md | 11 ++++++----- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index fdb742cdb..0e20a01bf 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ Fixes **If your build fails** due to your commit message not passing the build checks, please review the guidelines here: https://github.com/emqx/emqx/blob/master/CONTRIBUTING.md. ## PR Checklist -Please convert it to a draft if any of the following conditions are not met. Reviewers may skip over until all the items are checked.: +Please convert it to a draft if any of the following conditions are not met. Reviewers may skip over until all the items are checked: - [ ] Tests for the changes have been added (for bug fixes / features) - [ ] Docs have been added / updated (for bug fixes / features) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f91359e19..5e73359e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,11 +29,14 @@ Example 1: ``` feat: add Fuji release compose files +``` + +``` fix(script): correct run script to use the right ports -Previously device services used wrong port numbers. This commit fixes the port numbers to use the latest port numbers . +Previously device services used wrong port numbers. This commit fixes the port numbers to use the latest port numbers. -Closes: #123 +Closes: #123, #245, #992 ``` ### Revert @@ -76,6 +79,4 @@ Just as in the **subject**, use the imperative, present tense: "change" not "cha The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**. -**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. - -
\ No newline at end of file +**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. \ No newline at end of file