Skip to content

Commit d379dcb

Browse files
hannahlanzrathjbreue16
authored andcommitted
Update documentation to adhere to GIT Community Standards
Renames CONTRIBUTORS.md to CONTRIBUTING.md and changes all references. Adds code of conduct, the security policy and a pull request template.
1 parent 26f977c commit d379dcb

File tree

317 files changed

+491
-316
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

317 files changed

+491
-316
lines changed

CMakeLists.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# CADET
33
#
44
# Copyright © The CADET Authors
5-
# Please see the CONTRIBUTORS.md file.
5+
# Please see the CONTRIBUTING.md file.
66
#
77
# All rights reserved. This program and the accompanying materials
88
# are made available under the terms of the GNU Public License v3.0 (or, at

CODE_OF_CONDUCT.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
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, religion, or sexual identity
10+
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
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of 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
35+
address, 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 e-mail 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+
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
86+
of 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
93+
permanent 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
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

CONTRIBUTORS.md CONTRIBUTING.md

File renamed without changes.

LICENSE.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
COPYRIGHT AND LICENSE NOTICE
22

3-
Copyright � 2008-2024: The CADET Authors, please see the CONTRIBUTORS.md file.
3+
Copyright � 2008-2024: The CADET Authors, please see the CONTRIBUTING.md file.
44

55
This program is free software: you can redistribute it and/or modify it under the terms of the
66
GNU General Public License as published by the Free Software Foundation, either version 3 of

README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,6 @@ Released under GPL v3. License (see `LICENSE.txt <https://github.com/cadet/cadet
8383
Acknowledgments
8484
---------------
8585

86-
Please refer to the `list of contributors <https://github.com/cadet/cadet-core/blob/master/CONTRIBUTORS.md>`_ who helped building and funding this project.
86+
Please refer to the `list of contributors <https://github.com/cadet/cadet-core/blob/master/CONTRIBUTING.md>`_ who helped building and funding this project.
8787

8888
Copyright (C) 2004-2024 CADET Authors

SECURITY.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Security Policy
2+
3+
## 1. No Network Dependencies
4+
5+
CADET operates entirely offline and does not require any network access, nor does it handle sensitive information such as personal identifiers. This eliminates common attack vectors like network exploits or data breaches.
6+
7+
## 2. Code Integrity and Contribution Reviews
8+
9+
While there are no significant security risks associated with using CADET, we maintain strict controls over our source code. Any external contributions to the project are thoroughly reviewed and must meet our contribution guidelines. All pull requests are checked to ensure they do not introduce vulnerabilities.
10+
11+
## 3. Dependency Management
12+
13+
CADET does not rely on third-party libraries that introduce network or verification components. We carefully manage dependencies to ensure they are up-to-date and secure.
14+
15+
## 4. Reporting Vulnerabilities
16+
17+
Though CADET does not involve typical security risks, we encourage users and contributors to report any unexpected behavior or potential vulnerabilities they may discover. Please contact us via [email protected] if you believe you've found a security issue.

cmake/Modules/FindCADET.cmake

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# CADET
33
#
44
# Copyright © The CADET Authors
5-
# Please see the CONTRIBUTORS.md file.
5+
# Please see the CONTRIBUTING.md file.
66
#
77
# All rights reserved. This program and the accompanying materials
88
# are made available under the terms of the GNU Public License v3.0 (or, at

cmake/Modules/FindSUNDIALS.cmake

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# CADET
33
#
44
# Copyright © The CADET Authors
5-
# Please see the CONTRIBUTORS.md file.
5+
# Please see the CONTRIBUTING.md file.
66
#
77
# All rights reserved. This program and the accompanying materials
88
# are made available under the terms of the GNU Public License v3.0 (or, at

cmake/Modules/FindSuperLU.cmake

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# CADET
33
#
44
# Copyright © The CADET Authors
5-
# Please see the CONTRIBUTORS.md file.
5+
# Please see the CONTRIBUTING.md file.
66
#
77
# All rights reserved. This program and the accompanying materials
88
# are made available under the terms of the GNU Public License v3.0 (or, at

cmake/Modules/FindUMFPACK.cmake

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# CADET
33
#
44
# Copyright © The CADET Authors
5-
# Please see the CONTRIBUTORS.md file.
5+
# Please see the CONTRIBUTING.md file.
66
#
77
# All rights reserved. This program and the accompanying materials
88
# are made available under the terms of the GNU Public License v3.0 (or, at

cmake/Modules/MatlabTBBversion.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

doc/developer_guide/TemplateBinding.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/Exceptions.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/ExternalFunction.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/FactoryFuncs.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/HashUtil.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/InletProfile.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/LibExportImport.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/LibVersionInfo.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/Logging.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/Model.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/ModelBuilder.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/ModelSystem.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/Notification.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/ParameterId.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/ParameterProvider.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/Simulator.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/SolutionExporter.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/SolutionRecorder.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/StringUtil.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

include/cadet/StrongTypes.hpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// CADET
33
//
44
// Copyright © The CADET Authors
5-
// Please see the CONTRIBUTORS.md file.
5+
// Please see the CONTRIBUTING.md file.
66
//
77
// All rights reserved. This program and the accompanying materials
88
// are made available under the terms of the GNU Public License v3.0 (or, at

0 commit comments

Comments
 (0)