Skip to content

Commit 48f2abe

Browse files
spigadspigad
authored
Initial commit
0 parents  commit 48f2abe

18 files changed

+475
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
# Code of Conduct
2+
3+
This code of conduct applies to the maintainers and contributors alike.
4+
5+
## Dealing with issues and support requests
6+
7+
_We wish to add a specific section on dealing with issues opened against the
8+
repository here._
9+
10+
This repository exists in the context of the interTwin project. While that scope
11+
does not restrict the usage, it does inform the priority we assign to issues and
12+
the order we deal with them.
13+
14+
We welcome issues reported by the public, and more specifically the community of
15+
people using this repository.
16+
17+
While we undertake to do everything in our power to respond to issues in a
18+
timely manner, and to prioritise issues based on reasonable requests from
19+
submitters, the maintainers expect that the prioritisation of issues as decided
20+
by them is respected.
21+
22+
## Our Pledge
23+
24+
In the interest of fostering an open and welcoming environment, we as
25+
contributors and maintainers pledge to making participation in our project and
26+
our community a harassment-free experience for everyone, regardless of age, body
27+
size, disability, ethnicity, gender identity and expression, level of
28+
experience, nationality, personal appearance, race, religion, or sexual identity
29+
and orientation.
30+
31+
## Our Standards
32+
33+
Examples of behaviour that contributes to creating a positive environment
34+
include:
35+
36+
- Using welcoming and inclusive language
37+
- Being respectful of differing viewpoints and experiences
38+
- Gracefully accepting constructive criticism
39+
- Focusing on what is best for the community
40+
- Showing empathy towards other community members
41+
42+
Examples of unacceptable behaviour by participants include:
43+
44+
- The use of sexualized language or imagery and unwelcome sexual attention or
45+
advances
46+
- Trolling, insulting/derogatory comments, and personal or political attacks
47+
- Public or private harassment
48+
- Publishing others' private information, such as a physical or electronic
49+
address, without explicit permission
50+
- Other conduct which could reasonably be considered inappropriate in a
51+
professional setting
52+
53+
## Our Responsibilities
54+
55+
Project maintainers are responsible for clarifying the standards of acceptable
56+
behaviour and are expected to take appropriate and fair corrective action in
57+
response to any instances of unacceptable behaviour.
58+
59+
Project maintainers have the right and responsibility to remove, edit, or reject
60+
comments, commits, code, wiki edits, issues, and other contributions that are
61+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
62+
contributor for other behaviours that they deem inappropriate, threatening,
63+
offensive, or harmful.
64+
65+
## Scope
66+
67+
This Code of Conduct applies both within project spaces and in public spaces
68+
when an individual is representing the project or its community. Examples of
69+
representing a project or community include using an official project e-mail
70+
address, posting via an official social media account, or acting as an appointed
71+
representative at an online or offline event. Representation of a project may be
72+
further defined and clarified by project maintainers.
73+
74+
## Enforcement
75+
76+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
77+
reported by contacting the interTwin project team at info@interTwin.eu. The team will
78+
review and investigate all complaints, and will respond in a way that it deems
79+
appropriate to the circumstances. The team is obligated to maintain
80+
confidentiality with regard to the reporter of an incident. Further details of
81+
specific enforcement policies may be posted separately.
82+
83+
Project maintainers who do not follow or enforce the Code of Conduct in good
84+
faith may face temporary or permanent repercussions as determined by other
85+
members of the project's leadership.
86+
87+
## Attribution
88+
89+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
90+
version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
91+
92+
[homepage]: http://contributor-covenant.org
93+
[version]: http://contributor-covenant.org/version/1/4/

‎.github/ISSUE_TEMPLATE.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!--
2+
Thank you for opening an issue in our repository.
3+
Please use the template below to construct the issue.
4+
5+
Dealing with issues:
6+
- Issues opened here will be evaluated by the maintainers, and given priority
7+
based on that evaluation.
8+
- Support is provided on a best-effort basis
9+
- See the CODE_OF_CONDUCT.md for a deeper description of how we deal with support
10+
and issues.
11+
-->
12+
13+
# Short Description of the issue
14+
15+
<!--
16+
Please provide a plain-language description of what you would like to report.
17+
By using simple, concise language, you can help the maintainers understand the
18+
issue and context, and thereby help them prioritise it.
19+
-->
20+
21+
## Environment
22+
23+
<!--
24+
Provide details of the environment you used when this error occurred
25+
-->
26+
27+
- Operating System:
28+
- Other related components versions:
29+
30+
## Steps to reproduce
31+
32+
<!--
33+
If this is a runtime or other error, please describe what you did to generate the
34+
error
35+
-->
36+
37+
## Logs, stacktrace, or other symptoms
38+
39+
<!--
40+
If you have logs or other supporting information like the stack trace from python,
41+
etc, paste it here.
42+
Use markdown formatting to put output in code blocks
43+
-->
44+
45+
```shell
46+
output
47+
```
48+
49+
<!-- the section below is optional - remove it if you don't know what to propose,
50+
but merely want to report an issue. -->
51+
52+
# Summary of proposed changes

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!--
2+
A good PR should describe what benefit this brings to the repository.
3+
Ideally, there is an existing issue which the PR address.
4+
5+
Please check the Contributing guide CONTRIBUTING.md for style requirements and
6+
advice.
7+
-->
8+
9+
# Summary
10+
11+
<!-- Describe in plain English what this PR does -->
12+
13+
---
14+
15+
<!-- Add, if any, the related issue here, e.g. #6 -->
16+
17+
**Related issue :**

‎.github/dependabot.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
version: 2
3+
updates:
4+
# Maintain dependencies for GitHub Actions
5+
- package-ecosystem: "github-actions"
6+
directory: "/"
7+
schedule:
8+
interval: "daily"

‎.github/linters/.flake8‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[flake8]
2+
# https://black.readthedocs.io/en/stable/guides/using_black_with_other_tools.html#flake8
3+
extend-ignore = E203,W503
4+
max-line-length = 88

‎.github/linters/.markdownlint.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"MD013": {
3+
"line_length": 120,
4+
"code_blocks": false,
5+
"tables": false
6+
},
7+
"MD014": false,
8+
"MD024": false,
9+
"MD026": {
10+
"punctuation": ".,:;!"
11+
}
12+
}

‎.github/linters/mlc_config.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"httpHeaders": [
3+
{
4+
"urls": ["https://docs.github.com/"],
5+
"headers": {
6+
"Accept-Encoding": "zstd, br, gzip, deflate"
7+
}
8+
}
9+
],
10+
"ignorePatterns": [
11+
{
12+
"pattern": "^http://localhost"
13+
},
14+
{
15+
"pattern": "^https://example.com"
16+
},
17+
{
18+
"pattern": "https://github.com/interTwin-eu/REPOSITORY/issues/new"
19+
},
20+
{
21+
"pattern": "https://github.com/interTwin-eu/REPOSITORY/graphs/contributors"
22+
}
23+
]
24+
}

‎.github/workflows/check-links.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Check links
3+
4+
on:
5+
push:
6+
pull_request:
7+
8+
jobs:
9+
markdown-link-check:
10+
name: Check links using markdown-link-check
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
# Checks out a copy of your repository on the ubuntu-latest machine
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
with:
18+
# Make sure the actual branch is checked out when running on PR
19+
# ref: ${{ github.event.pull_request.head.sha }}
20+
# Full git history needed to get proper list of changed files
21+
fetch-depth: 0
22+
23+
- name: Check links on new changes
24+
uses: gaurav-nelson/github-action-markdown-link-check@v1
25+
with:
26+
config-file: ".github/linters/mlc_config.json"
27+
check-modified-files-only: "yes"
28+
use-quiet-mode: "yes"
29+
use-verbose-mode: "yes"
30+
base-branch: "main"

‎.github/workflows/lint.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: Lint
3+
4+
on:
5+
push:
6+
pull_request:
7+
8+
jobs:
9+
super-lint:
10+
name: Lint with Super-Linter
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
# Checks out a copy of your repository on the ubuntu-latest machine
15+
- name: Checkout code
16+
uses: actions/checkout@v4
17+
with:
18+
# Make sure the actual branch is checked out when running on PR
19+
# ref: ${{ github.event.pull_request.head.sha }}
20+
# Full git history needed to get proper list of changed files
21+
fetch-depth: 0
22+
23+
# Runs the Super-Linter action
24+
- name: Run Super-Linter on new changes
25+
uses: docker://ghcr.io/github/super-linter:slim-v4
26+
env:
27+
DEFAULT_BRANCH: main
28+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
29+
MARKDOWN_CONFIG_FILE: .markdownlint.json
30+
# Only check new or edited files
31+
VALIDATE_ALL_CODEBASE: false
32+
# Fail on errors
33+
DISABLE_ERRORS: false

‎.prettierrc.toml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Configuration for prettier
2+
# https://prettier.io/docs/en/configuration.html
3+
proseWrap = "always"
4+
tabWidth = 2
5+
printWidth = 80

0 commit comments

Comments
 (0)