Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Add cli class diagram #1707

Merged
merged 11 commits into from
Mar 23, 2021
Merged

docs: Add cli class diagram #1707

merged 11 commits into from
Mar 23, 2021

Conversation

jan-goral
Copy link
Contributor

@jan-goral jan-goral commented Mar 17, 2021 •
edited
Loading

In the scope of #1493

This PR adds a class diagram for the CLI layer and short documentation.

Files

  • flank/docs/hld/presentation/cli/readme.md

  • cli_class_diagram

Checklist

  • CLI class diagram
  • Relations
  • Command names
  • Links to kt files (works only through plantuml idea plugin)
  • Packages
  • Color commands that are running domain code
  • Links to commands on Github

@jan-goral jan-goral self-assigned this Mar 17, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2021 •
edited
Loading

CLA Assistant Lite bot All contributors have signed the CLA ✍️ ✅

@github-actions github-actions bot added Documentation Pull request which touches documentation Tech Debt labels Mar 17, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Mar 17, 2021 •
edited
Loading

Timestamp: 2021-03-23 07:38:50
Buildscan url for ubuntu-workflow run 678782009
https://gradle.com/s/4awytn465dy22

@jan-goral jan-goral marked this pull request as ready for review March 18, 2021 10:46
@bootstraponline bootstraponline force-pushed the 1493-add-cli-class-diagram branch from 05d9c25 to 9fd3970 Compare March 18, 2021 12:17
@mergify
Copy link

mergify bot commented Mar 18, 2021

Title does not follow the guidelines of Conventional Commits.
Please adjust title before merge and use one of following prefix:

  • build - Changes that affect the build system or external dependencies (dependencies update)
  • ci - Changes to our CI configuration files and scripts (basically directory .github/workflows)
  • docs - Documentation only changes
  • feat - A new feature
  • fix - A bug fix
  • chore - Changes which does not touch the code (ex. manual update of release notes). It will not generate release notes changes
  • refactor - A code change that contains refactor
  • style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test - Adding missing tests or correcting existing tests and also changes for our test app
  • perf - A code change that improves performance (I do not think we will use it)

@jan-goral jan-goral marked this pull request as draft March 18, 2021 16:53
@jan-goral jan-goral marked this pull request as ready for review March 18, 2021 17:41
@mergify
Copy link

mergify bot commented Mar 18, 2021

Title does not follow the guidelines of Conventional Commits.
Please adjust title before merge and use one of following prefix:

  • build - Changes that affect the build system or external dependencies (dependencies update)
  • ci - Changes to our CI configuration files and scripts (basically directory .github/workflows)
  • docs - Documentation only changes
  • feat - A new feature
  • fix - A bug fix
  • chore - Changes which does not touch the code (ex. manual update of release notes). It will not generate release notes changes
  • refactor - A code change that contains refactor
  • style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test - Adding missing tests or correcting existing tests and also changes for our test app
  • perf - A code change that improves performance (I do not think we will use it)

1 similar comment
@mergify
Copy link

mergify bot commented Mar 19, 2021

Title does not follow the guidelines of Conventional Commits.
Please adjust title before merge and use one of following prefix:

  • build - Changes that affect the build system or external dependencies (dependencies update)
  • ci - Changes to our CI configuration files and scripts (basically directory .github/workflows)
  • docs - Documentation only changes
  • feat - A new feature
  • fix - A bug fix
  • chore - Changes which does not touch the code (ex. manual update of release notes). It will not generate release notes changes
  • refactor - A code change that contains refactor
  • style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test - Adding missing tests or correcting existing tests and also changes for our test app
  • perf - A code change that improves performance (I do not think we will use it)

@jan-goral jan-goral force-pushed the 1493-add-cli-class-diagram branch from 7b7bcb7 to 40b672a Compare March 19, 2021 01:08
@mergify
Copy link

mergify bot commented Mar 19, 2021

Title does not follow the guidelines of Conventional Commits.
Please adjust title before merge and use one of following prefix:

  • build - Changes that affect the build system or external dependencies (dependencies update)
  • ci - Changes to our CI configuration files and scripts (basically directory .github/workflows)
  • docs - Documentation only changes
  • feat - A new feature
  • fix - A bug fix
  • chore - Changes which does not touch the code (ex. manual update of release notes). It will not generate release notes changes
  • refactor - A code change that contains refactor
  • style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test - Adding missing tests or correcting existing tests and also changes for our test app
  • perf - A code change that improves performance (I do not think we will use it)

1 similar comment
@mergify
Copy link

mergify bot commented Mar 19, 2021

Title does not follow the guidelines of Conventional Commits.
Please adjust title before merge and use one of following prefix:

  • build - Changes that affect the build system or external dependencies (dependencies update)
  • ci - Changes to our CI configuration files and scripts (basically directory .github/workflows)
  • docs - Documentation only changes
  • feat - A new feature
  • fix - A bug fix
  • chore - Changes which does not touch the code (ex. manual update of release notes). It will not generate release notes changes
  • refactor - A code change that contains refactor
  • style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test - Adding missing tests or correcting existing tests and also changes for our test app
  • perf - A code change that improves performance (I do not think we will use it)

@jan-goral jan-goral marked this pull request as draft March 19, 2021 01:12
@jan-goral jan-goral force-pushed the 1493-add-cli-class-diagram branch 3 times, most recently from 995d5df to 971121d Compare March 19, 2021 02:52
@jan-goral jan-goral marked this pull request as ready for review March 22, 2021 14:42
@bootstraponline bootstraponline force-pushed the 1493-add-cli-class-diagram branch from af0e0ff to 32f1bc6 Compare March 22, 2021 14:43
@mergify
Copy link

mergify bot commented Mar 22, 2021

Title does not follow the guidelines of Conventional Commits.
Please adjust title before merge and use one of following prefix:

  • build - Changes that affect the build system or external dependencies (dependencies update)
  • ci - Changes to our CI configuration files and scripts (basically directory .github/workflows)
  • docs - Documentation only changes
  • feat - A new feature
  • fix - A bug fix
  • chore - Changes which does not touch the code (ex. manual update of release notes). It will not generate release notes changes
  • refactor - A code change that contains refactor
  • style - Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test - Adding missing tests or correcting existing tests and also changes for our test app
  • perf - A code change that improves performance (I do not think we will use it)

@piotradamczyk5 piotradamczyk5 changed the title Add cli class diagram docs: Add cli class diagram Mar 22, 2021
@mergify mergify bot merged commit ac71a83 into master Mar 23, 2021
@mergify mergify bot deleted the 1493-add-cli-class-diagram branch March 23, 2021 08:32
@github-actions github-actions bot locked and limited conversation to collaborators Mar 23, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@pawelpasterz pawelpasterz pawelpasterz approved these changes

@Sloox Sloox Sloox approved these changes

@adamfilipow92 adamfilipow92 Awaiting requested review from adamfilipow92

@zuziaka zuziaka Awaiting requested review from zuziaka

@piotradamczyk5 piotradamczyk5 Awaiting requested review from piotradamczyk5

Assignees

@jan-goral jan-goral

Labels
Documentation Pull request which touches documentation Tech Debt
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jan-goral @Sloox @pawelpasterz