diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2a8a408a98..88ffdac7dc 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -62,6 +62,6 @@ For example: -- [ ] `Doc - TODO` +- [ ] `Doc - TODO` - [ ] `Doc - Done` - [ ] `Doc - No Need` diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 7056afd978..8d63e0608c 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -125,6 +125,12 @@ Note that since GitHub requires submitting code through `username + token` (inst Go to the web page of GitHub fork repo, there would be a chance to create a Pull Request after pushing to a new branch, click the button "Compare & pull request" to do it. Then edit the description for proposed changes, which can just be copied from the commit message. +If the change touches a feature, a configuration item or a `Dockerfile`, open the matching +documentation PR in [hugegraph-doc](https://github.com/apache/hugegraph-doc) at the same time +and link the two together. Both should merge together. Documentation that trails the code +goes stale quietly, and the gap is only found when a user or a search tool reads the wrong +thing. + Note: please make sure the email address you used to submit the code is bound to the GitHub account. For how to bind the email address, please refer to https://github.com/settings/emails: image