Files
my-rook-config/.github/PULL_REQUEST_TEMPLATE.md
T
Blaine Gardner 4fdbdeb542 PR template: Add godoc comments to checklist
We want to have good code documentation in the future, and we would like
to slowly develop better documentation for existing code. As a checklist
item for PRs, add a requirement for godoc-style comments when (1) new
code items are added and (2) when existing items are sufficiently
modified.

Signed-off-by: Blaine Gardner <blaine.gardner@suse.com>
2018-08-14 14:03:22 -06:00

811 B

Description of your changes:

Which issue is resolved by this Pull Request: Resolves #

Checklist:

  • Documentation has been updated, if necessary.
  • Pending release notes updated with breaking and/or notable changes, if necessary.
  • Upgrade from previous release is tested and upgrade user guide is updated, if necessary.
  • Code generation (make codegen) has been run to update object specifications, if necessary.
  • make vendor does not cause changes.
  • Comments have been added or updated based on the standards set in CONTRIBUTING.md