diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-11 06:09:00 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-11 06:09:00 +0300 |
| commit | 574ed32358d8e502793bf133099d1b6e3b8e3d76 (patch) | |
| tree | fc7e88674da5abf366b3619f5954cacbb1157eef /doc/development/refactoring_guide/index.md | |
| parent | 67d19cc004e5956ca51a85050fceedaa55750526 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/refactoring_guide/index.md')
| -rw-r--r-- | doc/development/refactoring_guide/index.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/development/refactoring_guide/index.md b/doc/development/refactoring_guide/index.md index eac5ad43e74..44beb0623a9 100644 --- a/doc/development/refactoring_guide/index.md +++ b/doc/development/refactoring_guide/index.md @@ -18,14 +18,14 @@ Pinning tests help you ensure that you don't unintentionally change the output o 1. For each possible input, identify the significant possible values. 1. Create a test to save a full detailed snapshot for each helpful combination values per input. This should guarantee that we have "pinned down" the current behavior. The snapshot could be literally a screenshot, a dump of HTML, or even an ordered list of debugging statements. 1. Run all the pinning tests against the code, before you start refactoring (Oracle) -1. Perform the refactor (or checkout the commit with the work done) +1. Perform the refactor (or check out the commit with the work done) 1. Run again all the pinning test against the post refactor code (Pin) 1. Compare the Oracle with the Pin. If the Pin is different, you know the refactoring doesn't preserve existing behavior. 1. Repeat the previous three steps as necessary until the refactoring is complete. ### Example commit history -Leaving in the commits for adding and removing pins helps others checkout and verify the result of the test. +Leaving in the commits for adding and removing pins helps others check out and verify the result of the test. ```shell AAAAAA Add pinning tests to funky_foo |