Merge branch 'release/v1.25.0'

.circleci/config.yml

@@ -1633,7 +1633,7 @@ executors:
     working_directory: ~/projects
     docker:
       - image: cimg/python:3.8.14-node
-      - image: ehrbase/ehrbase-postgres:13.4
+      - image: ehrbase/ehrbase-postgres:13.4.v2
         environment:
           POSTGRES_USER: postgres
           POSTGRES_PASSWORD: postgres

.github/ISSUE_TEMPLATE/defect.md

@@ -1,44 +1,40 @@
 ---
 name: Bug
-about: Something is not working as expected and must be fixed
+about: Report a bug encountered when working with openEHR_SDK
 labels: bug
 ---
 
-## Configuration information
+# Environment information
 
-<!-- To reproduce your problem is is mandatory to give the following information. You can get all of
-them in one step by starting the EHRbase and requesting a GET on 
-`%ehrbaseBaseUri%/ehrbase/rest/status`.  -->
+<!--
 
+Uncomment and fill this if the SDK is used to connect to EHRbase
+
+/> To help reproducing your problem it is mandatory to give some information on the environment. You can get an aggregate of this data by starting EHRbase and performing a GET request on
+`%ehrbaseBaseUri%/ehrbase/rest/status`.
+
+ 
 - EHRbase version:
+-->
+
 - openEHR_SDK version:
 - Archie version:
 - PostgreSQL version:
 - Java Runtime version:
 - Operating System version:
 
-## Steps to reproduce ## 
-
-<!-- Describe here what steps have to be executed with which data entered to reproduce the erroneous
-behaviour. Also include Operational Templates as an attachment if used. -->
+# Steps to reproduce
 
-## Actual result ##
+> Describe the steps that you have taken until the unexpected behavior occurred. Please try to add as many details as possible, and include data and templates as attachments.
 
-<!-- Describe the wrong output / behaviour. Attached images are always helpful. -->
+# Actual result
 
-## Expected result (Acceptance Criteria) ##
+> Describe the wrong output / behavior.
 
-<!-- Describe the expected output / behaviour. -->
+# Expected result
 
-## Definition of Done ##
+> Describe the expected output / behavior.
 
-<!-- These checklist entries are used by our developers to deliver a solution with a base quality
-we want to acheive. If you want to add other points specific to this issue, put them into the section
-"Expected result (Acceptance Criteria)" -->
+# Further information
 
-- [ ] The defect is checked by an unit or an integration test (Robot)
-- [ ] Merge Request approved
-- [ ] Unit tests passed
-- [ ] Build without errors
-- [ ] Release notes prepared
-- [ ] No additional runtime warnings
+> Add additional information, if needed.

.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,17 @@
+---
+name: Enhancement
+about: Enhancement proposal for a new / extended functionality of EHRbase
+labels: enhancement
+---
+
+# Background
+
+> Describe the context and intention for this enhancement, such as the benefits and impacts on the user.
+
+# Enhancement
+
+> Provide specific preconditions, steps, requirements or expectations on the proposed enhancement
+
+# Further information
+
+> Add additional information, if needed.

.github/ISSUE_TEMPLATE/task.md

@@ -1,20 +1,17 @@
 ---
 name: Task
-about: A general task that has to be done. Can be a research or other common work to be done.
+about: A general task, e.g. research or other common work to be done
 labels: task
 ---
-## Background ##
 
-<!-- Describe the task and the research goal that is expected after this issue has been moved to done -->
+# Background
 
-## Acceptance Criteria ##
+> Describe the goal of this task, and the expectations or impacts on EHRbase after this task has been completed.
 
-<!-- Add items here or describe what is expected as the result of the task, i.e. a wiki entry, a 
-conceptual document or a configured tool that executes recurring tasks. -->
+# Task specification
 
-- [ ] Item1
+> Add specific steps or work descriptions with the expected results.
 
-## Definition of Done ##
+# Further information
 
-- [ ] Output has been reviewed or presented and has been approved
-- [ ] Documentation has been updated (Sphinx, Javadoc, Guidelines, etc.) if applicable
+> Add additional information, if needed.

.github/ISSUE_TEMPLATE/pull.yml → .github/pull.yml

@@ -1,8 +1,8 @@
 version: "1"
 rules:
   - base: master
-    upstream: ehrbase:master
+    upstream: openEHR_SDK:master
     mergeMethod: hardreset
   - base: develop
-    upstream: ehrbase:develop
+    upstream: openEHR_SDK:develop
     mergeMethod: hardreset

.github/pull_request_template.md

@@ -0,0 +1,21 @@
+# Changes
+
+> Describe your changes in a short and concise list.
+
+# Related issue
+
+> Reference related issues, and use one of the [closing keywords, e.g. closes or fixes](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) to link the corresponding issue, if any.
+
+# Additional information 
+
+> Provide additional information for this change, if needed.
+
+# Pre-Merge checklist
+
+- [ ] New code is tested
+- [ ] Present and new tests pass
+- [ ] Documentation is updated
+- [ ] The build is working without errors
+- [ ] No new Sonar issues introduced
+- [ ] Changelog is updated
+- [ ] Code has been reviewed 

CHANGELOG.md

@@ -2,6 +2,14 @@
 
 Note: version releases in the 0.x.y range may introduce breaking changes.
 
+## [1.25.0]
+### Added
+### Changed
+
+- FlatPathDto is now immutable ([#425](https://github.com/ehrbase/openEHR_SDK/pull/425))
+
+### Fixed
+
 ## [1.24.0]
  ### Added 
 - Added client support for managing compositions trough contributions ([#406](https://github.com/ehrbase/openEHR_SDK/pull/406))
@@ -221,3 +229,4 @@ Note: version releases in the 0.x.y range may introduce breaking changes.
 [1.22.0]: https://github.com/ehrbase/openEHR_SDK/compare/v1.21.0...v1.22.0
 [1.23.0]: https://github.com/ehrbase/openEHR_SDK/compare/v1.22.0...v1.23.0
 [1.24.0]: https://github.com/ehrbase/openEHR_SDK/compare/v1.23.0...v1.24.0
+[1.25.0]: https://github.com/ehrbase/openEHR_SDK/compare/v1.24.0...v1.25.0

CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations