Prechádzať zdrojové kódy

docs: format contributing

zhanghongtong 5 rokov pred
rodič
commit
ca47dae699
2 zmenil súbory, kde vykonal 7 pridanie a 6 odobranie
  1. 1 1
      .github/PULL_REQUEST_TEMPLATE.md
  2. 6 5
      CONTRIBUTING.md

+ 1 - 1
.github/PULL_REQUEST_TEMPLATE.md

@@ -4,7 +4,7 @@ Fixes <issue-number>
 **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)

+ 6 - 5
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.
-
-<details class="details-reset details-overlay details-overlay-dark" id="jumpto-line-details-dialog" style="box-sizing: border-box; display: block;"><summary data-hotkey="l" aria-label="Jump to line" role="button" style="box-sizing: border-box; display: list-item; cursor: pointer; list-style: none;"></summary></details>
+**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.