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

Introduce architecture decision records #27

Merged
merged 6 commits into from
Mar 15, 2022

Conversation

agrancaric
Copy link
Collaborator

@agrancaric agrancaric commented Mar 7, 2022

Basic information

  • nrich version:
    1.2.0
  • Module:
    Project

Additional information

Description

Introducing architecture decision records.

Summary

We want an easy way of recording our architecture and coding choices. This PR introduces architecture decision records for the current state of the project and a template for writing new decision records.

Details

Related issue

#26

Types of changes

  • Docs change

Checklist

  • I have read the project's CONTRIBUTING document
  • I have checked my code with the project's static analysis tooling
  • I have formatted my code with the project's IDEA code-style configuration
  • I have checked my code for misspellings
  • I have organized my changes in easy-to-follow commits
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests pass

@agrancaric agrancaric self-assigned this Mar 7, 2022
@agrancaric agrancaric force-pushed the feature_introduceArchitectureDecisionRecords branch from 46bcda5 to ed87515 Compare March 7, 2022 16:21
@jsajlovic jsajlovic changed the title Introduce architeture decision records Introduce architecture decision records Mar 7, 2022
@agrancaric agrancaric force-pushed the feature_introduceArchitectureDecisionRecords branch from ed87515 to ed01b31 Compare March 8, 2022 08:06
@agrancaric agrancaric requested a review from jsajlovic March 8, 2022 08:06
@agrancaric agrancaric force-pushed the feature_introduceArchitectureDecisionRecords branch 2 times, most recently from 40db805 to 3c33140 Compare March 9, 2022 08:28
jsajlovic
jsajlovic previously approved these changes Mar 9, 2022
Copy link
Collaborator

@jzrilic jzrilic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionally, I would have one commit per ADR.

@agrancaric agrancaric force-pushed the feature_introduceArchitectureDecisionRecords branch from 3c33140 to a614387 Compare March 15, 2022 08:19
@agrancaric agrancaric requested review from jzrilic and jsajlovic March 15, 2022 08:20
@agrancaric agrancaric force-pushed the feature_introduceArchitectureDecisionRecords branch from a614387 to facb432 Compare March 15, 2022 11:17
@agrancaric agrancaric force-pushed the feature_introduceArchitectureDecisionRecords branch from facb432 to 4d27f84 Compare March 15, 2022 12:05
@jzrilic jzrilic merged commit 4180253 into master Mar 15, 2022
@jzrilic jzrilic deleted the feature_introduceArchitectureDecisionRecords branch March 15, 2022 15:47
@agrancaric agrancaric linked an issue Mar 18, 2022 that may be closed by this pull request
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.

Introduce Architecture Decision Records
3 participants