feat: add requirement tracing with mantra

.github/ISSUE_TEMPLATE/add-test.md

@@ -0,0 +1,24 @@
+---
+name: Add Test
+about: Propose a new test case.
+title: "[TEST] "
+labels: ["waiting-on-assignee"]
+assignees: ''
+
+---
+
+## Is this test case related to other issues/PRs?
+
+
+
+## Describe the test case steps
+
+
+
+## Describe alternatives you've considered
+
+
+
+## Additional context
+
+

.github/ISSUE_TEMPLATE/bug-report-form.yml

@@ -0,0 +1,41 @@
+name: Bug Report Form
+description: Form that guides you to create a bug report.
+title: "[Bug] "
+# Source partially taken from: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more information?
+      placeholder: ex. [email protected]
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what happened!
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: What version of our software where you running?
+      placeholder: ex. v1.0.1 or post the git commit hash
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/mhatzl/evident/blob/main/CODE_OF_CONDUCT.md).
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,31 @@
+---
+name: Bug Report
+about: Create a bug report to help us improve.
+title: "[BUG] "
+labels: ["waiting-on-assignee"]
+assignees: ''
+
+---
+
+## Describe the bug you've found, and why you think it is a bug
+
+
+
+## To Reproduce
+
+**Steps to reproduce the behavior:**
+
+1. ...
+
+
+## Screenshots
+
+
+
+## Version/Branch used
+
+
+
+## Additional context
+
+

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Project Discussions
+    url: https://github.com/mhatzl/evident/discussions
+    about: Please ask and answer questions here.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,24 @@
+---
+name: Feature Request
+about: Tell us about a feature you need.
+title: "[REQ] "
+labels: ["waiting-on-assignee", "req-missing-wiki-entry"]
+assignees: ''
+
+---
+
+## Is your feature request related to other issues/PRs?
+
+
+
+## Describe the solution you'd like
+
+
+
+## Describe alternatives you've considered
+
+
+
+## Additional context
+
+

.github/ISSUE_TEMPLATE/improve-documentation.md

@@ -0,0 +1,16 @@
+---
+name: Improve Documentation
+about: Is there something you do not understand?
+title: "[DOC] "
+labels: ["waiting-on-assignee"]
+assignees: ''
+
+---
+
+## Describe what is/was unclear to you 
+
+
+
+## Describe what would help you to better understand the documentation
+
+

.github/ISSUE_TEMPLATE/other-topic.md

@@ -0,0 +1,10 @@
+---
+name: Other Topic
+about: Select if you are not sure what else to choose.
+title: "[OTHER] "
+labels: ["waiting-on-assignee"]
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/spelling-mistake.md

@@ -0,0 +1,16 @@
+---
+name: Spelling Mistake
+about: Help us improve our spelling.
+title: "[SPELL] "
+labels: ["waiting-on-assignee", "good-first-issue"]
+assignees: ''
+
+---
+
+## Where is the spelling mistake located? 
+
+
+
+## Describe the mistake
+
+

.github/ISSUE_TEMPLATE/warn-us.md

@@ -0,0 +1,16 @@
+---
+name: Warn Us
+about: Warn us about a possible problem.
+title: "[WARN] "
+labels: ["waiting-on-assignee"]
+assignees: ''
+
+---
+
+## Describe what you want to warn us about
+
+
+
+## Describe what you suggest doing about it
+
+

.github/pull_request_template.md

@@ -0,0 +1,30 @@
+## List of issues that this PR closes
+
+[[
+
+e.g. closes #1 closes #2 …
+
+]]
+
+## Definition of Done ([req:qa.DoD])
+
+**Please consider the following requirements:**
+
+- [ ] Add/Update requirement references (see: [req:qa.tracing])
+- [ ] Add usage examples in doc-comments (see: [req:qa.ux.usage])
+- [ ] Only use macros if they improve *evident's* usability (see: [req:qa.ux.macros])
+- [ ] Prefer `RwLock` over `Mutex` (see: [req:qa.perf.locks])
+
+**Note:** You may ignore requirements that are not relevant to your PR.
+
+## Decisions you made for this PR
+
+{{
+
+Add a clear and concise description about your decisions related to this PR.
+
+**Note:** May be omitted if decisions are documented in committed files.
+
+**Note:** Decisions may be added to the "Decision Records" section in the wiki.
+
+}}

.github/workflows/mantra_pr.yml

@@ -0,0 +1,55 @@
+# Runs mantra check to write the overview of reference changes in a PR comment.
+name: mantra-pr
+on:
+    pull_request:
+
+permissions:
+    issues: write
+    pull-requests: write
+
+jobs:
+    mantra-pr:
+        runs-on: ubuntu-latest
+        container:
+            image: manuelhatzl/mantra:main
+
+        env:
+            BRANCH_NAME: ${{ github.base_ref }} 
+
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                repository: 'mhatzl/evident-wiki'
+                path: './req_folder'
+                sparse-checkout: 5-Requirements
+
+            - uses: actions/checkout@v3
+              with:
+                path: './proj_folder'
+
+            - name: check
+              id: check
+              # '&>' to get stderr and stdout in one file, so error logs get included in output.
+              # Uses ' ' (U+2002) instead of regular space for output, because GitHub output cannot handle regular spaces
+              # see: https://stackoverflow.com/questions/59191913/how-do-i-get-the-output-of-a-specific-step-in-github-actions
+              run: |
+                mantra check --branch-name=$BRANCH_NAME ./req_folder ./proj_folder &> check_overview.md
+                output="$(cat check_overview.md)"
+                output="${output//\'/\\\'}"
+                output="${output//\"/\\\"}"
+                output="${output//$'\n'/\\\\n}"
+                output="${output// / }" 
+                cat check_overview.md
+                echo "check-overview=$output" >> $GITHUB_OUTPUT
+
+            - name: comment
+              uses: actions/github-script@v6
+              with:
+                script: |
+                    const check_overview = '${{ steps.check.outputs.check-overview }}'.replaceAll('\\n', '\n')
+                    await github.rest.issues.createComment({
+                        issue_number: context.issue.number,
+                        owner: context.repo.owner,
+                        repo: context.repo.repo,
+                        body: check_overview
+                    })

.github/workflows/mantra_sync.yml

@@ -0,0 +1,63 @@
+name: mantra-sync
+on: 
+  push:
+    branches: main
+
+permissions:
+    contents: write
+
+jobs:
+    # Synchronizes references between project and wiki.
+    mantra-sync:
+        runs-on: ubuntu-latest
+        container:
+            image: manuelhatzl/mantra:main
+
+        env:
+            BRANCH_NAME: ${{ github.ref_name }} 
+
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                repository: 'mhatzl/evident-wiki'
+                path: './wiki'
+                # PAT with 'workflow' permission required in case wiki-links in workflow files get updated
+                token: ${{ secrets.EVIDENT_TOKEN }}
+
+            - uses: actions/checkout@v3
+              with:
+                path: './proj_folder'
+
+            - name: sync-references
+              run: mantra sync --branch-name=$BRANCH_NAME --branch-link=https://github.com/mhatzl/evident/tree/$BRANCH_NAME ./wiki/5-Requirements ./proj_folder
+
+            - name: job-date
+              id: job-date
+              # '-u' for UTC 
+              run: |
+                echo "date=$(date -u +'%Y-%m-%d_%H:%M UTC')" >> $GITHUB_OUTPUT
+
+            - name: update-sidebar
+              run: |
+                sed -i -r "s/\*\*Last update:\*\*.+/\*\*Last update:\*\* ${{ steps.job-date.outputs.date }}  /" ./wiki/_Sidebar.md
+                repo=$(echo "${{ github.repository }}")
+                repo=${repo//\//\\/}
+                sed -i -r "s/\*\*Repository:\*\*.+/\*\*Repository:\*\* $repo  /" ./wiki/_Sidebar.md
+                sed -i -r "s/\*\*Branch:\*\*.+/\*\*Branch:\*\* $BRANCH_NAME  /" ./wiki/_Sidebar.md
+                short_sha=$(echo "${{ github.sha }}")
+                short_sha=${short_sha:0:7}
+                commit_link=$(echo "${{ github.server_url }}/${{ github.repository }}/commit/${{ github.sha }}")
+                commit_link=${commit_link//\//\\/}
+                sed -i -r "s/\*\*Commit:\*\*.+/\*\*Commit:\*\* \[$short_sha\]\($commit_link\)  /" ./wiki/_Sidebar.md
+
+            - name: push-changes
+              working-directory: ./wiki
+              # In case nothing changed
+              continue-on-error: true
+              run: |
+                git config user.name github-actions
+                git config user.email [email protected]
+                git status
+                git add .
+                git commit -m "chore: sync references between wiki and project"
+                git push