From 230998fdf07d5510f232592a842a0f46b8f5474c Mon Sep 17 00:00:00 2001 From: Jay Bazuzi Date: Sat, 23 Apr 2022 13:34:35 -0700 Subject: [PATCH] F** switch from `x ` to `x - ` https://github.com/RefactoringCombos/ArlosCommitNotation/issues/26 --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index e7dcf39..d7ddaf0 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ This is particularly useful when: | Risk Level | Code | Example | Meaning | | --- | --- | --- | --- | -| **Known safe** | lowercase letter | `r Extract method Applesauce` | Addresses all known and unknown risks. | -| **Validated** | uppercase letter | `R Extract method Applesauce` | Addresses all known risks. | +| **Known safe** | lowercase letter | `r - Extract method Applesauce` | Addresses all known and unknown risks. | +| **Validated** | uppercase letter | `R - Extract method Applesauce` | Addresses all known risks. | | **Risky** | uppercase followed by 2 bangs | `R!! Extract method Applesauce` | Known risks remain unverified. | | **(Probably) Broken** | uppercase followed by 2 stars | `R** Start extracting method with no name` | No risk attestation. | @@ -50,8 +50,8 @@ Each intention can appear at any of the 4 risk levels. Each intention's full det | Code | Known Approaches | | --- | --- | -| `f ` | None known | -| `F ` | Meets all of: | +| `f - ` | None known | +| `F - ` | Meets all of: | | `F!!` | Change includes unit tests for new behavior. | | `F**` | No automatic tests, or unfinished implementation. | @@ -68,8 +68,8 @@ A bugfix is a lot like a feature. However, the intention is to change an undesir | Code | Known Approaches | | --- | --- | -| `b ` | None known | -| `B ` | Meets all of: | +| `b - ` | None known | +| `B - ` | Meets all of: | | `B!!` | Change includes unit tests for new behavior. | | `B**` | No automatic tests, or unfinished implementation. | @@ -86,8 +86,8 @@ A Refactoring or Remodeling intends to alter the program in some way without cha | Code | Known Approaches | | --- | --- | -| `r ` | One of: | -| `R ` | Test-supported Procedural Refactoring[3] | +| `r - ` | One of: | +| `R - ` | Test-supported Procedural Refactoring[3] | | `R!!` | Identified single, named refactoring, but executed by editing code or without whole-project test coverage. | | `R**` | Remodeled by editing code, even in small chunks. | @@ -103,8 +103,8 @@ Changes that don't impact the code, but do change documentation around the code. | Code | Known Approaches | | --- | --- | -| `d ` | Developer-visible documentation, not in a source file, or verified to generate byte-identical compilation. | -| `D ` | Dev-impacting only, but changes compilation or process. E.g., changing text on a dev-only screen, or changes code-review checklist. | +| `d - ` | Developer-visible documentation, not in a source file, or verified to generate byte-identical compilation. | +| `D - ` | Dev-impacting only, but changes compilation or process. E.g., changing text on a dev-only screen, or changes code-review checklist. | | `D!!` | Alters an important process. | | `D**` | Trying out a process change that is intended to gain info, not to work. |