Skip to content

Commit c25db88

Browse files
TheMrSheldonTheMrSheldon
committed
added a CITATION, CODE_OF_CONDUCT, and SECURITY file; overhauled CONTRIBUTING and updated the date in LICENSE
1 parent 8e028fe commit c25db88

File tree

5 files changed

+245
-7
lines changed

5 files changed

+245
-7
lines changed

‎CITATION.cff

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
cff-version: 1.2.0
2+
title: TIRA
3+
message: >-
4+
If you use this software, please cite it using the
5+
metadata from this file.
6+
type: software
7+
authors:
8+
- given-names: Maik
9+
family-names: Fröbe
10+
- given-names: Matti
11+
family-names: Wiegmann
12+
- given-names: Nikolay
13+
family-names: Kolyada
14+
- given-names: Bastian
15+
family-names: Grahm
16+
- given-names: Theresa
17+
family-names: Elstner
18+
- given-names: Frank
19+
family-names: Loebe
20+
- given-names: Matthias
21+
family-names: Hagen
22+
- given-names: Benno
23+
family-names: Stein
24+
- given-names: Martin
25+
family-names: Potthast
26+
identifiers:
27+
- type: url
28+
value: >-
29+
https://link.springer.com/chapter/10.1007/978-3-031-28241-6_20
30+
repository-code: 'https://github.com/tira-io/tira'
31+
url: 'https://tira.io/'
32+
abstract: >-
33+
A major obstacle to the long-term impact of most shared
34+
tasks is their lack of reproducibility. Often only the
35+
test collections and the papers of the organizers and
36+
participants are published. Third parties who want to
37+
independently evaluate the state of the art for a task on
38+
other data must re-implement the participants’ software.
39+
The tools developed to collect software from participants
40+
in shared tasks only partially verify its reliability at
41+
the time of submission, much less long-term, and do not
42+
enable third parties to reuse it later. We have overhauled
43+
the TIRA Integrated Research Architecture to address all
44+
of these issues. The new version simplifies task setup for
45+
organizers and software submission for participants,
46+
scales from a local computer to the cloud, supports
47+
on-demand resource allocation up to parallel CPU and GPU
48+
processing, and enables export for local reproduction with
49+
just a few lines of code. This is achieved by implementing
50+
the TIRA protocol with an industry-standard continuous
51+
integration and deployment (CI/CD) pipeline using Git,
52+
Docker, and Kubernetes.
53+
license: MIT

‎CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+55-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,60 @@
11
# Contributing to TIRA
2-
TODO
2+
Thank you for considering a contribution to TIRA!
3+
4+
Below, you will find all the information on how you can help, how to get started and what to consider when contributing.
5+
Please also have a look TIRA's [Code of Conduct](./CODE_OF_CONDUCT.md).
6+
7+
Contributions can take many forms, and all are very welcome:
8+
9+
1. Reporting Bugs
10+
1. Reporting Vulnerabilities
11+
1. Suggesting Enhancements and new Features
12+
1. Contributing Code
13+
1. Improving the Documentation
14+
15+
## Reporting Bugs
16+
Bugs are annoying for everyone, so please help us identify and fix the bug by providing a good bug report.
17+
18+
**What is a good Bug Report?**
19+
A good bug report should contain the expected behavior, the observed behavior and all the necessary actions you took.
20+
Ideally, it should be reproducible but we understand that this is not always possible. Please make sure to follow these
21+
steps before submitting a bug report:
22+
23+
- Check the [Issues Page](https://github.com/tira-io/tira/issues) if others have reported similar problems (also make
24+
sure to search the open and the closed issues)
25+
- Check that you are using TIRAs latest version
26+
- Read the relevant [Documentation](https://tira-io.github.io/tira/) to make sure you are experiencing a bug
27+
28+
**How do I submit a Bug Report?**
29+
Bug reports should contain all the relevant information needed for someone else to understand and (hopefully) reproduce
30+
your issue. You can report a bug using GitHub Issues as follows:
31+
32+
1. Make sure you have read "What is a good Bug Report?"
33+
2. Open a new [Bug Issue](https://github.com/tira-io/tira/issues/new?assignees=&labels=bug&projects=&template=00-bug-issue.md)
34+
3. Fill in the forms to the best of your abilities and try to describe the reproduction steps as concise as possible
35+
(e.g., only include steps that are relevant to the reproduction)
36+
4. **Make sure you do NOT leak any confidential data (e.g., API Keys or Secrets) on accident!**
37+
38+
## Reporting Vulnerabilities
39+
Vulnerabilities should not publicly be disclosed until they are fixed. Please have a look at our
40+
[Security Policy](SECURITY.md) for more information.
41+
42+
## Suggesting Enhancements and new Features
43+
Is there something that is bugging you (but is not a bug) or a feature you believe should be part of TIRA? Perfect!
44+
Please open an [Enhancement Issue](https://github.com/tira-io/tira/issues/new?assignees=&labels=enhancement&projects=&template=40-enhancement-issue.md)
45+
and make sure to cover the following points to give your idea the best chance of being implemented:
346

4-
## Styleguides
5-
### Git
6-
### Python
7-
### Java
47+
- **Clearly and concisely** describe the idea behind the enhancement or feature. The more people have to read, the less
48+
they are motivated to read your entire proposal and the less likely they are to support it.
49+
- Now that you got people hooked, you can be more elaborate: how (if at all) can the goal be achieved now? How do you
50+
envision it to work if your feature request or enhancement is implemented?
51+
- A picture is worth a thousand words — you may add pictures to show what you envision. This is, of course, not
52+
required.
853

9-
## Submitting Changes
54+
## Contributing Code
1055
TODO
1156

57+
## Improving the Documentation
58+
Documentation is *PART OF* the software and not a second class citizen. Good documentation simplifies the onboarding
59+
process of new programmers and new users. Generally, the same guidelines apply as for
60+
[contributing code](#contributing-code).

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2012-2023 tira.io
3+
Copyright (c) 2012-2024 tira.io
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎SECURITY.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Security Policy
2+
3+
If you believe you have found a vulnerability, please, **DO NOT** publicize it, e.g., by opening an issue. Instead,
4+
please use the [Security](https://github.com/tira-io/tira/security/new) tab on TIRA's GitHub repository.

0 commit comments

Comments
 (0)