Skip to content

Add decision record for analysis and design documentation - #6281

Merged
t2gran merged 4 commits into
opentripplanner:dev-2.xfrom
entur:otp_dr_model
Dec 4, 2024
Merged

Add decision record for analysis and design documentation#6281
t2gran merged 4 commits into
opentripplanner:dev-2.xfrom
entur:otp_dr_model

Conversation

@t2gran

@t2gran t2gran commented Nov 26, 2024

Copy link
Copy Markdown
Member

Summary

This adds a guideline for analysis and design. It include a sheet cheat for drawing UML domain models.

Issue

🟥 No issue

Unit tests

🟥 Doc only

Documentation

✅ This is developer doc

Changelog

🟥 Not relevant

Bumping the serialization version id

🟥 Not needed

@t2gran t2gran added !Documentation Improve documentation targeting users and/or developers. !Technical Debt Improve code quality, no functional changes. labels Nov 26, 2024
@t2gran t2gran added this to the 2.7 (next release) milestone Nov 26, 2024
@t2gran
t2gran requested a review from a team as a code owner November 26, 2024 19:55
@leonardehrenfried leonardehrenfried changed the title Add dessition record for analysis and design documentation Add decision record for analysis and design documentation Nov 27, 2024
Comment thread doc/dev/decisionrecords/AnalysesAndDesign.md Outdated
Comment thread doc/dev/decisionrecords/AnalysesAndDesign.md Outdated
Comment thread doc/dev/decisionrecords/AnalysesAndDesign.md Outdated
Comment thread doc/dev/decisionrecords/AnalysesAndDesign.md Outdated
Comment thread doc/dev/decisionrecords/AnalysesAndDesign.md Outdated
Co-authored-by: Leonard Ehrenfried <mail@leonard.io>
@leonardehrenfried

Copy link
Copy Markdown
Member

Which software did you use for the diagram? Maybe it's worth recommending something.

@codecov

codecov Bot commented Nov 27, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.76%. Comparing base (bc3147f) to head (90068af).
Report is 71 commits behind head on dev-2.x.

Additional details and impacted files
@@            Coverage Diff             @@
##             dev-2.x    #6281   +/-   ##
==========================================
  Coverage      69.76%   69.76%           
+ Complexity     17752    17751    -1     
==========================================
  Files           2010     2010           
  Lines          75948    75948           
  Branches        7784     7784           
==========================================
  Hits           52984    52984           
  Misses         20257    20257           
  Partials        2707     2707           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@t2gran

t2gran commented Nov 27, 2024

Copy link
Copy Markdown
Member Author

Which software did you use for the diagram? Maybe it's worth recommending something.

I used draw.io - I will add a recommendation.

@optionsome
optionsome requested a review from tkalvas November 28, 2024 15:29
@t2gran
t2gran merged commit bb7ab76 into opentripplanner:dev-2.x Dec 4, 2024
@t2gran
t2gran deleted the otp_dr_model branch December 4, 2024 00:34
t2gran pushed a commit that referenced this pull request Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

!Documentation Improve documentation targeting users and/or developers. !Technical Debt Improve code quality, no functional changes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants