bitflicker64 opened a new pull request, #3198: URL: https://github.com/apache/hugegraph/pull/3198
## Purpose of the PR Draft for discussion, companion to https://github.com/apache/hugegraph/pull/3197. The PR template already has a `Documentation Status` section, so the intent is there. The problem is the first option: ``` - [ ] `Doc - TODO` <!-- Your PR changes impact docs and you will update later --> ``` "You will update later" is a promise with nothing attached to it. No link, no issue, no follow-up, so once the code PR merges the box is the only record that documentation was owed, and it stops being visible to anyone. The result is documentation that describes an older version of the code, which readers and search tools then pick up as current. `CONTRIBUTING.md` does not mention documentation at all in the section on opening a PR, which is the point where a contributor decides whether to write any. ## Main Changes - `.github/PULL_REQUEST_TEMPLATE.md`: `Doc - TODO` now asks for a link, either the hugegraph-doc PR or a tracking issue. Same three options, same structure, one comment reworded. - `docs/CONTRIBUTING.md`: one paragraph in section 4, saying that a change to a feature, a configuration item or a `Dockerfile` opens the matching hugegraph-doc PR at the same time, and that the two merge together. 7 lines added, 1 reworded. Two open points for review: 1. Should `Doc - TODO` require a link, or be removed entirely so the choice is `Done` or `No Need`? Requiring a link is the softer option and is what this PR does. 2. `CONTRIBUTING.md` says the website copy at https://hugegraph.apache.org/docs/contribution-guidelines/ is authoritative. If this lands, the same paragraph needs a matching hugegraph-doc PR, which is the rule applying to itself. ## Verifying these changes - [x] Trivial rework / code cleanup without any test coverage. (No Need) - [ ] Already covered by existing tests, such as *(please modify tests here)*. - [ ] Need tests and can be verified as follows: - xxx ## Does this PR potentially affect the following parts? - [ ] Dependencies ([add/update license](https://hugegraph.apache.org/docs/contribution-guidelines/contribute/#321-check-licenses) info & [regenerate_known_dependencies.sh](../install-dist/scripts/dependency/regenerate_known_dependencies.sh)) - [ ] Modify configurations - [ ] The public API - [x] Other affects (typed here) - Changes the PR template every contributor sees, and the contribution guide. - [ ] Nope ## Documentation Status <!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. --> - [x] `Doc - TODO` <!-- website contribution-guidelines page needs the same paragraph, see point 2 above --> - [ ] `Doc - Done` - [ ] `Doc - No Need` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
