Commit eea53c08 authored by Lukas Riedel's avatar Lukas Riedel 📝 Committed by Santiago Ospina De Los Ríos

Update contribution guide

* Update information on how to register in GitLab instance.
* Add new guidelines for reporting bugs and planning implementation.
* Add section on creating releases.
parent f9d2aa83
......@@ -66,6 +66,7 @@
* Unit and system tests report code coverage separately !172
* Improve docs on config file parameters and make default ones executable !183
* Upgrade `spdlog` submodule to v1.5.0 !192
* Update the contribution guidelines and the code of conduct !194
### Fixed
* Allow meta-ini files for unit tests !101
......
......@@ -2,74 +2,127 @@
## 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,
education, socio-economic status, nationality, personal appearance, race,
religion, or sexual identity and orientation.
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
Examples of behavior that contributes to a positive environment for our
community 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
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior by participants include:
Examples of unacceptable behavior include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or 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
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
## Enforcement Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.
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 behaviors that they deem inappropriate,
threatening, offensive, or harmful.
Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.
## 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.
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at
[dorieteam@iup.uni-heidelberg.de](mailto:dorieteam@iup.uni-heidelberg.de). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
reported to the community leaders responsible for enforcement at
[dorieteam@iup.uni-heidelberg.de](mailto:dorieteam@iup.uni-heidelberg.de).
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
reporter of any incident.
## Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:
### 1. Correction
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.
**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.
### 2. Warning
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.
**Community Impact**: A violation through a single incident or series
of actions.
**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.
### 3. Temporary Ban
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.
**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
the community.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
# Contributing to DORiE
**Thank you for taking your time and contributing to DORiE!** :+1:
**Thank you for taking your time and contributing to DORiE!** 👍
## License and Distribution
DORiE is licensed under the
[GNU General Public License Version 3](https://www.gnu.org/licenses/gpl-3.0.en.html).
Contributors to the DORiE project and source code agree that their contributions
are published and may be distributed according to this license. All contributors
will be acknowledged in the [authors list](COPYING.md#copyright-holders).
## Code of Conduct
......@@ -19,32 +27,58 @@ therefore prefer public contributions of any kind via GitLab.
The DORiE repository is hosted on the private GitLab instance of the
[TS-CCEES](http://ts.iup.uni-heidelberg.de/) research group at the
[Institute of Environmental Physics (IUP) Heidelberg](http://www.iup.uni-heidelberg.de/).
As we want to keep most of our projects private, we disabled the regular
sign-up procedure. If you are not a member of said research group, we encourage
you to request an account [via mail][mailinglist]. Notice that you will only
receive an account flagged as
"[External User](https://docs.gitlab.com/ee/user/permissions.html#external-users-core-only)"
in this case, with access to the DORiE repository only.
### Issues and Merge Requests
As the GitLab instance hosts many of our group-internal projects, new users
will be registered as
[external users](https://docs.gitlab.com/ee/user/permissions.html#external-users-core-only)
with access to the public repositories only and without rights to create their
own projects. Use the "Request Access" button if you want to become a member
of a certain project.
### Questions and Bug Reports
Before asking questions or reporting bugs, please make sure your issue cannot be
resolved by following the instructions in the
[Troubleshooting](README.md#troubleshooting) section of the `README.md`.
If you want to report a bug, [raise an issue][issue] and use the `bug-report`
description template to provide as much information as possible. We prefer
discussing even minor issues in public, so feel free to open an issue for
presumably minor questions as well.
Report bugs, suggest features, or plan implementations in GitLab Issues. We
provide several Description Templates you may find useful for structuring
your Issue description and providing the required information.
### Code Development
Suggest features or plan implementations in GitLab issues. We provide the
`task` and `meta-task` description templates for structuring your planning
and for providing the required information to other developers.
Consult the [Doxygen documentation][doxygen] of the DORiE source code for
information on how certain features of DORiE are used within the C++ source
code.
Any changes to source code should be accompanied by a (unit) test verifying the
functionality. Designing this test ideally happens in the planning phase of
a change.
a change. DORiE vendors [Google Test](https://github.com/google/googletest) as
unit test framework. Check out the [Doxygen documentation][doxygen] for
information on how to employ the framework in DORiE.
After a proper discussion of the Issue, and the resulting implementation, open
a Merge Request. Again, we encourage you to use one of the Description
Templates. Provide information on how your code changes and additions solve the
After a proper discussion of the issue, and the resulting implementation, open
a merge request. Again, we encourage you to use one of the description
templates. Provide information on how your code changes and additions solve the
problem or implement the feature. Make sure that your MR fulfills the the
criteria for being merged.
### Releases
Tasks for creating and publishing a release are listed in the `version-rollout`
and `patch-release` issue description templates. For patching a release, an
additional `patch-release` merge request description template is provided.
### Old-Fashioned Email
Of course, you can always contact the developers directly
[via mail][mailinglist].
[mailinglist]: mailto:dorieteam@iup.uni-heidelberg.de
[issue]: https://ts-gitlab.iup.uni-heidelberg.de/dorie/dorie/-/issues/new?
[doxygen]: https://hermes.iup.uni-heidelberg.de/dorie_doc/master/doxygen/html/index.html
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment