summaryrefslogtreecommitdiffstats
path: root/Help/dev/review.rst
Commit message (Collapse)AuthorAgeFilesLines
* Help/dev: Move integration testing to a more-specific documentBrad King2024-06-051-2/+2
| | | | | Avoid breaking existing links to `Help/dev/testing.rst` by keeping the document with minimal text to direct readers to the new one.
* gitlab-ci: shorten job prefixesBen Boeckel2021-11-221-0/+13
| | | | | | | | | | This helps to maximize the amount of information visible in the GitLab web interface. Also document their meaning in the developer documentation and in the CI configuration file directly. See: https://gitlab.com/gitlab-org/gitlab/-/issues/8496
* Help/dev/review: Clarify instructions to update existing merge requestsSmit tay2021-05-031-2/+4
|
* Help/dev/review: mention `--pretty=reference`Ben Boeckel2021-04-071-1/+2
| | | | This was added in Git 2.25 (13 Jan 2020).
* Help/dev: Update CMake Review Process document to suggest 'git describe'Brad King2020-08-201-0/+1
| | | | | Using `git describe --contains` is the preferred way to reference a commit relative to a tag.
* Fix typos identified using codespellJean-Christophe Fillion-Robin2020-07-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | See https://github.com/codespell-project/codespell#readme The following command was used: ``` codespell -q6 --skip="\ .git,\ *.json,\ ./Copyright.txt,\ ./Help/command/foreach.rst,\ ./Help/prop_test/REQUIRED_FILES.rst,\ ./Help/variable/CTEST_COVERAGE_COMMAND.rst,\ ./Modules/CMakeCheckCompilerFlagCommonPatterns.cmake,\ ./Modules/CMakeRCInformation.cmake,\ ./Modules/Internal/CPack/NSIS.template.in,\ ./Modules/FindMatlab.cmake,\ ./Modules/MatlabTestsRedirect.cmake,\ ./Modules/Platform/Windows-Clang.cmake,\ ./Modules/Platform/Windows-Intel-Fortran.cmake,\ ./Modules/Platform/Windows-MSVC.cmake,\ ./Source/CMakeVersion.cmake,\ ./Source/cmConvertMSBuildXMLToJSON.py,\ ./Source/cmCreateTestSourceList.cxx,\ ./Source/cmGlobalVisualStudio10Generator.cxx,\ ./Source/cmExportBuildFileGenerator.cxx,\ ./Source/cmExportInstallAndroidMKGenerator.cxx,\ ./Source/cmExportInstallFileGenerator.cxx,\ ./Source/cmExportSet.cxx,\ ./Source/cmExportTryCompileFileGenerator.cxx,\ ./Source/cmFindPackageCommand.cxx,\ ./Source/cmInstallCommand.cxx,\ ./Source/cmGeneratorExpressionLexer.cxx,\ ./Source/cmLocalVisualStudio7Generator.cxx,\ ./Source/cmOrderDirectories.cxx,\ ./Source/cmTarget.cxx,\ ./Source/kwsys/*,\ ./Source/QtDialog/CMakeSetupDialog.ui,\ ./Source/CPack/WiX/cmWIXRichTextFormatWriter.cxx,\ ./Source/CTest/cmParseCoberturaCoverage.h,\ ./Tests/CMakeTests/ImplicitLinkInfoTest.cmake.in,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/English.license.rtf,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/German.license.txt,\ ./Tests/RunCMake/CPack/tests/DMG_SLA/German.menu.txt,\ ./Tests/RunCMake/GoogleTest/xml_output.cpp,\ ./Tests/RunCMake/Make/TargetMessages*,\ ./Utilities/*,\ " \ -L "\ dependees,\ endwhile,\ fo,\ filetest,\ helpfull,\ nd,\ objext,\ stoll,\ supercedes,\ superceded,\ vas,\ varn,\ " ```
* Help/dev: document other arguments to `Do: test`Ben Boeckel2020-06-091-0/+13
|
* Help/dev: Update CMake Review Process document for GitLab CIBrad King2020-06-091-34/+31
| | | | | We have replaced use of `buildbot` with GitLab CI. Update the relevant section of our review process documentation.
* Update links to gitlab.kitware.com repos to add `-/`Brad King2020-05-261-4/+4
| | | | | | GitLab now uses a `/-/` component between the `group/project` part of the URL and the `{issues,merge_requests,tree}` part so that it can support `group/subgroup/project` with arbitrary depth.
* Help/dev: Document "Backport:" footer for MR descriptionsBrad King2019-11-111-0/+17
|
* Help/dev: Add 'external-discussion' to the main workflow status listBrad King2019-11-061-0/+4
| | | | | | This was accidentally left out of commit 49f5b6f7bf (Help: Document the expire and external discussion resolve states, 2019-05-26, v3.15.0-rc1~35^2).
* Help: Document the expire and external discussion resolve statesCraig Scott2019-05-301-7/+68
| | | | | | Our practice of closing MRs temporarily while discussion takes place in a separate issue isn't always well understood by MR authors. Expiring a MR seems to be better understood, but making it clear that it is also a temporary state is helpful.
* Help: prefer commit hashes in commit referencesBen Boeckel2019-01-251-5/+14
| | | | | | | | | | | The logic is that the describe output is readily available using `git tag --contains` locally. In addition, for a hypothetical commit which landed in both v3.9.4 and v3.10.1, there is no "better" tag to refer to. since v3.10.0's relation to such a commit is unclear either way. Also mention that a `Fixes` trailer is preferred if the mention is just to indicate a commit which introduced an error rather than writing a complete sentence about it.
* Help/dev: Document where topic stage branch is heldBrad King2018-12-191-0/+8
|
* Help: Clarify usage of Topic-renameCraig Scott2018-05-291-2/+5
|
* Help/dev: Add commit reference format to review process guideBrad King2017-08-291-0/+20
|
* Help/dev: Organize commit message instructions into subsectionsBrad King2017-08-241-0/+9
|
* Help/dev: Add commit message guidelinesCraig Scott2017-08-081-0/+48
|
* Help/dev: Document buildbot lint-iwyu-tidy builderBrad King2017-05-301-1/+6
| | | | | This builder builds CMake using lint tools but does not run the test suite. Document it for reviewers to request with `Do: test -i lint`.
* Help/dev: note that unstaging before an update is unnecessaryBen Boeckel2017-05-171-0/+4
|
* Help/dev: Document preferred page for MR commentsBrad King2017-04-061-0/+4
|
* Help/dev: Document `Do: reformat` actionBrad King2017-03-221-0/+16
|
* Help/dev: Make `Do: check` cross-reference more specificBrad King2017-03-221-1/+4
| | | | Add a dedicated subsection header for its documentation.
* Help/dev: Document `Topic-rename:` description trailerBrad King2017-03-211-0/+7
|
* Help/dev: mention how the robot performs its checksBen Boeckel2017-03-211-3/+8
| | | | Fixes: #16264.
* Help/dev: Document the CMake Testing ProcessBrad King2017-03-071-8/+10
|
* Help/dev: Document the CMake Review ProcessBrad King2017-03-031-0/+304