Skip to content

Commit

Permalink
docs: fix first diagram in algos
Browse files Browse the repository at this point in the history
  • Loading branch information
dd84ai committed Dec 10, 2023
1 parent e5ce51e commit db2d995
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions docs/development/algos.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ your githook is activated and tries to parse your commit name accroding to git c

```mermaid
flowchart TD
GitCommit[attempt to fixate commit like
git commit -m 'feat: add md rendering'
with 'autogit hook activate' enabled]
GitCommit[attempt to fixate commit like\ngit commit -m 'feat: add md rendering'\nwith 'autogit hook activate' enabled]
RequestValidatingChangelog[Request changelog with --validate flag] --> TryParsingCommitMessage
GitCommit --> TryParsingCommitMessage[Try parsing commit message\nto git conventional commit\ntype \ scope \ subject \ body \ footers]
TryParsingCommitMessage --> ReportFail[Reporting errors if unable]
Expand All @@ -21,7 +19,7 @@ flowchart TD
CheckOtherEnabledRulesInSettings --> WhenAppliedRules
CheckOptionalValidationRulesIfEnabled --> WhenAppliedRules[when applied rules]
WhenAppliedRules --> IfCommit[if it was commit,\nthen fixate if passed rules,\nor cancel fixation]
WhenAppliedRules --> IfChangelog[if it was changelog validation\nthen report no errors and exit code 0\nfor pipeline checks]
WhenAppliedRules --> IfChangelog[if it was changelog validation\nthen report no errors and exit code 0 \n for pipeline checks]
```

## scenario #2 - changelog / Your wish to see changelog of additions you made, what are new features, what are fixes. For user view
Expand Down

0 comments on commit db2d995

Please sign in to comment.