139af60cc0
It is generally useful for PR authors to go through their own PR first to make sure that commonly occurring feedback and issues have already been addressed. This checklist should help remind contributors what to look out for and is a living doc that we can modify and add to. I ask these questions to myself before submitting a PR, when looking through my changes in the "pre-PR-submit-view". Where possible leverage linter tools and CI gates to help address some of these. For example, for spell-check, here are some solutions to make things easier within the developer inner-loop: - VS Code extension: [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) - VS Code extension: [Markdown linter](https://github.com/DavidAnson/vscode-markdownlint) - Browser extension: [Site Spell](https://www.site-spell.com/)
759 B
759 B
Pull Request Checklist
Please leverage this checklist as a reminder to address commonly occurring feedback when submitting a pull request to make sure your PR can be reviewed quickly:
See the detailed list in the contributing guide.
- C++ Guidelines
- Doxygen docs
- Unit tests
- No unwanted commits/changes
- Descriptive title/description
- PR is single purpose
- Related issue listed
- Comments in source
- No typos
- Update changelog
- Not work-in-progress
- External references or docs updated
- Self review of PR done
- Any breaking changes?