Skip to content

Commit

Permalink
Add adr template and for adr for empty subdivisions
Browse files Browse the repository at this point in the history
  • Loading branch information
derTobsch committed Feb 20, 2024
1 parent ade4915 commit 559d6a8
Show file tree
Hide file tree
Showing 4 changed files with 59 additions and 16 deletions.
27 changes: 27 additions & 0 deletions .adr/001-document-every-subdivision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Document empty subdivision

## Status

Accepted

## Context

This decision arises from the discussion on https://github.com/focus-shift/jollyday/pull/388, where the identification for subdivisions was changed to 'ISO 3166-2'. There was uncertainty regarding whether to include subdivisions that do not have additional holidays compared to the country.

During the discussion, it was noted that having numerous subdivisions for a country like India while missing a few could lead to confusion and require significant time investment to identify the missing ones.

## Decision

The decision has been made to include all subdivisions, regardless of whether they have distinct holidays compared to the country.

## Consequences

For subdivisions without separate public holidays, an empty `SubConfigurations` will still be created. For instance, for `Ladākh`, it will appear as follows in the configuration:

```xml
<SubConfigurations hierarchy="la" description="Ladākh">
<Holidays/>
</SubConfigurations>
```

This ensures consistency and completeness in the documentation of subdivisions.
19 changes: 19 additions & 0 deletions .adr/999-adr-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Decision record template

# Title

## Status

What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.?

## Context

What is the issue that we're seeing that is motivating this decision or change?

## Decision

What is the change that we're proposing and/or doing?

## Consequences

What becomes easier or more difficult to do because of this change?
11 changes: 11 additions & 0 deletions .adr/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Architecture decision record (ADR)

Welcome to the directory dedicated to housing the defined architectural decisions for Jollyday.

For further insights and details, please refer to the [ADR List] provided in the top-level README document.

Additionally, if you wish to utilize our standardized template for recording architectural decisions,
it is conveniently accessible at [ADR Template].

[ADR List]: ../README.md
[ADR Template]: 999-adr-template.md
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,23 +212,9 @@ If you want to raise an **issue or bug** you can create a [new issue](https://gi

* [JDK 11](https://openjdk.java.net/install/)

### Clone the repository
### Architecture decision record (ADR)

```bash
git clone git@github.com:focus-shift/jollyday.git
```

### Build jollyday

```bash
./mvnw clean verify
```

or for Windows user:

```bash
./mvnw.cmd clean verify
```
* [Document empty subdivision](.adr/001-document-every-subdivision.md)

## License

Expand Down

0 comments on commit 559d6a8

Please sign in to comment.