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.

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

ADRs: Filling in impact sections for 001 - 006 #1446

Merged
merged 6 commits into from
Oct 17, 2024

Conversation

tjohnson7021
Copy link
Contributor

Filling in Impacts of ADRs that are missing an 'Impact' section

  • This PR covers filling in the impact sections for ADRs 001-006 so that it is understood why the decision was made at the time and what the concerns were.
  • An adr formatting guide adr-guidelines.md was also created and added to the repo in this PR.

NOTE: When you review, please keep in mind, I am using a mix of general research and experience to fill in these sections, so they may be lacking context-specific impacts of which I am unaware.

Issue #1247

Checklist

  • I have updated the documentation accordingly

Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis 🔶

1247 - Partially compliant

Fully compliant requirements:

  • Complete the "Impact" section for previously completed ADRs.

Not compliant requirements:

  • Create PRs for ADRs in batches for cleaner review.
⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Content Duplication
The 'Impact' section appears to have content that is very similar to the 'Positive' and 'Negative' subsections, which might be redundant.

Verbose Code
The 'Negative' impact about verbose code could be more specific about how it affects development time or maintenance.

adr/001-architecture-decision-records.md Show resolved Hide resolved
adr/002-java.md Show resolved Hide resolved
adr/003-gradle.md Show resolved Hide resolved
Copy link

sonarcloud bot commented Oct 17, 2024

This comment was marked as outdated.

@tjohnson7021 tjohnson7021 merged commit dc61126 into main Oct 17, 2024
17 checks passed
@tjohnson7021 tjohnson7021 deleted the devex/1247-add_impact_sections_001-006 branch October 17, 2024 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants