bigbone icon indicating copy to clipboard operation
bigbone copied to clipboard

Introduce ADRs for the project

Open andregasser opened this issue 2 years ago • 1 comments

Description

With this PR, I would like to introduce ADRs for this project, as discussed this morning on Slack. Based on the discussion outcome I have created the following:

  • an ADR process which describes how we want to discuss architectural topics in the future and how we get to our ADR.
  • an ADR template that should be used when creating a new ADR.

Happy to get some feedback on this. Let me know what you think.

Type of Change

  • Documentation

Breaking Changes

None.

How Has This Been Tested?

Not tested.

Mandatory Checklist

  • [x] I ran gradle check and there were no errors reported
  • [x] I have performed a self-review of my code
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • [x] All tests pass locally with my changes
  • [ ] I have added KDoc documentation to all public methods

Optional Things To Check

The items below are some more things to check before asking other people to review your code.

  • In case you worked on a new feature: Did you also implement the reactive endpoint (bigbone-rx)?
  • In case you added new *Methods classes: Did you also reference it in the MastodonClient main class?
  • Did you also update the documentation in the /docs folder (e.g. API Coverage page)?

andregasser avatar Nov 29 '23 13:11 andregasser

Codecov Report

Merging #365 (403aa1d) into master (dab65d4) will not change coverage. The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff            @@
##             master     #365   +/-   ##
=========================================
  Coverage     48.00%   48.00%           
  Complexity      501      501           
=========================================
  Files           137      137           
  Lines          3704     3704           
  Branches        242      242           
=========================================
  Hits           1778     1778           
  Misses         1734     1734           
  Partials        192      192           

codecov[bot] avatar Nov 29 '23 13:11 codecov[bot]