diff --git a/.adr/001-document-every-subdivision.md b/.adr/001-document-every-subdivision.md new file mode 100644 index 000000000..6b134c1ea --- /dev/null +++ b/.adr/001-document-every-subdivision.md @@ -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 + + + +``` + +This ensures consistency and completeness in the documentation of subdivisions. diff --git a/.adr/999-adr-template.md b/.adr/999-adr-template.md new file mode 100644 index 000000000..c99907f0e --- /dev/null +++ b/.adr/999-adr-template.md @@ -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? diff --git a/.adr/README.md b/.adr/README.md new file mode 100644 index 000000000..4fbed7e60 --- /dev/null +++ b/.adr/README.md @@ -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 diff --git a/README.md b/README.md index 18bc30528..8299c1d65 100644 --- a/README.md +++ b/README.md @@ -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