Initial commit

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,93 @@
+# Code of Conduct
+
+This code of conduct applies to the maintainers and contributors alike.
+
+## Dealing with issues and support requests
+
+_We wish to add a specific section on dealing with issues opened against the
+repository here._
+
+This repository exists in the context of the interTwin project. While that scope
+does not restrict the usage, it does inform the priority we assign to issues and
+the order we deal with them.
+
+We welcome issues reported by the public, and more specifically the community of
+people using this repository.
+
+While we undertake to do everything in our power to respond to issues in a
+timely manner, and to prioritise issues based on reasonable requests from
+submitters, the maintainers expect that the prioritisation of issues as decided
+by them is respected.
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of
+experience, nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+Examples of behaviour that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behaviour by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behaviour and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behaviour.
+
+Project maintainers 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, or to ban temporarily or permanently any
+contributor for other behaviours that they deem inappropriate, threatening,
+offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported by contacting the interTwin project team at [email protected]. The team will
+review and investigate all complaints, and will respond in a way that it deems
+appropriate to the circumstances. The team is obligated to maintain
+confidentiality with regard to the reporter of an incident. Further details of
+specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,52 @@
+<!--
+Thank you for opening an issue in our repository.
+Please use the template below to construct the issue.
+
+Dealing with issues:
+- Issues opened here will be evaluated by the maintainers, and given priority
+  based on that evaluation.
+- Support is provided on a best-effort basis
+- See the CODE_OF_CONDUCT.md for a deeper description of how we deal with support
+  and issues.
+-->
+
+# Short Description of the issue
+
+<!--
+Please provide a plain-language description of what you would like to report.
+By using simple, concise language, you can help the maintainers understand the
+issue and context, and thereby help them prioritise it.
+-->
+
+## Environment
+
+<!--
+Provide details of the environment you used when this error occurred
+-->
+
+- Operating System:
+- Other related components versions:
+
+## Steps to reproduce
+
+<!--
+If this is a runtime or other error, please describe what you did to generate the
+error
+-->
+
+## Logs, stacktrace, or other symptoms
+
+<!--
+If you have logs or other supporting information like the stack trace from python,
+etc, paste it here.
+Use markdown formatting to put output in code blocks
+-->
+
+```shell
+output
+```
+
+<!-- the section below is optional - remove it if you don't know what to propose,
+but merely want to report an issue.  -->
+
+# Summary of proposed changes

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+<!--
+A good PR should describe what benefit this brings to the repository.
+Ideally, there is an existing issue which the PR address.
+
+Please check the Contributing guide CONTRIBUTING.md for style requirements and
+advice.
+-->
+
+# Summary
+
+<!-- Describe in plain English what this PR does -->
+
+---
+
+<!-- Add, if any, the related issue here, e.g. #6 -->
+
+**Related issue :**

.github/dependabot.yml

@@ -0,0 +1,8 @@
+---
+version: 2
+updates:
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/linters/.flake8

@@ -0,0 +1,4 @@
+[flake8]
+# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8
+extend-ignore = E203,W503
+max-line-length = 88

.github/linters/.markdownlint.json

@@ -0,0 +1,12 @@
+{
+  "MD013": {
+    "line_length": 120,
+    "code_blocks": false,
+    "tables": false
+  },
+  "MD014": false,
+  "MD024": false,
+  "MD026": {
+    "punctuation": ".,:;!"
+  }
+}

.github/linters/mlc_config.json

@@ -0,0 +1,24 @@
+{
+  "httpHeaders": [
+    {
+      "urls": ["https://docs.github.com/"],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ],
+  "ignorePatterns": [
+    {
+      "pattern": "^http://localhost"
+    },
+    {
+      "pattern": "^https://example.com"
+    },
+    {
+      "pattern": "https://github.com/interTwin-eu/REPOSITORY/issues/new"
+    },
+    {
+      "pattern": "https://github.com/interTwin-eu/REPOSITORY/graphs/contributors"
+    }
+  ]
+}

.github/workflows/check-links.yml

@@ -0,0 +1,30 @@
+---
+name: Check links
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  markdown-link-check:
+    name: Check links using markdown-link-check
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks out a copy of your repository on the ubuntu-latest machine
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Make sure the actual branch is checked out when running on PR
+          # ref: ${{ github.event.pull_request.head.sha }}
+          # Full git history needed to get proper list of changed files
+          fetch-depth: 0
+
+      - name: Check links on new changes
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          config-file: ".github/linters/mlc_config.json"
+          check-modified-files-only: "yes"
+          use-quiet-mode: "yes"
+          use-verbose-mode: "yes"
+          base-branch: "main"

.github/workflows/lint.yml

@@ -0,0 +1,33 @@
+---
+name: Lint
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  super-lint:
+    name: Lint with Super-Linter
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checks out a copy of your repository on the ubuntu-latest machine
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          # Make sure the actual branch is checked out when running on PR
+          # ref: ${{ github.event.pull_request.head.sha }}
+          # Full git history needed to get proper list of changed files
+          fetch-depth: 0
+
+      # Runs the Super-Linter action
+      - name: Run Super-Linter on new changes
+        uses: docker://ghcr.io/github/super-linter:slim-v4
+        env:
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MARKDOWN_CONFIG_FILE: .markdownlint.json
+          # Only check new or edited files
+          VALIDATE_ALL_CODEBASE: false
+          # Fail on errors
+          DISABLE_ERRORS: false

.prettierrc.toml

@@ -0,0 +1,5 @@
+# Configuration for prettier
+# https://prettier.io/docs/en/configuration.html
+proseWrap = "always"
+tabWidth = 2
+printWidth = 80

.vscode/settings.json

@@ -0,0 +1,14 @@
+{
+    "markdownlint.config": {
+        "MD013": {
+            "line_length": 120,
+            "code_blocks": false,
+            "tables": false
+          },
+          "MD014": false,
+          "MD024": false,
+          "MD026": {
+            "punctuation": ".,:;!"
+          }
+    }
+}

AUTHORS.md

@@ -0,0 +1,9 @@
+# Authors
+
+## Maintainers
+
+Full Name \<email\>
+
+## Contributors
+
+[All contributors](https://github.com/interTwin-eu/REPOSITORY/graphs/contributors)

CHANGELOG

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [X.X.XX]
+- Change description (#PR_NUMBER) (AUTHOR)

CODEOWNERS

@@ -0,0 +1,10 @@
+# https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners
+# https://github.blog/2017-07-06-introducing-code-owners/
+
+# Assign code owners that will automatically get asked to review Pull Requests
+# The last matching pattern takes the most precedence.
+
+# These owners will be the default owners for everything in the repo.
+# Unless a later match takes precedence, they will be requested for
+# review when someone opens a pull request.
+