Merge pull request #262 from Met4FoF/add-code-of-conduct-1

Finally add a code of conduct
Met4FoF · Jul 23, 2021 · c9db19a · c9db19a
2 parents a746e95 + a63c414
commit c9db19a
Show file tree

Hide file tree

Showing 6 changed files with 216 additions and 33 deletions.
diff --git a/.gitignore b/.gitignore
@@ -19,6 +19,7 @@ docs/_build
 docs/README.md
 docs/agentMET4FOF_tutorials
 docs/CHANGELOG.md
+docs/CONTRIBUTING.md
 
 # Build clutter #
 #################

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+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 a positive environment for our
+community include:
+
+* 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 include:
+
+* 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 email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+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.
+
+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 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 to the community leaders responsible for enforcement at
+https://github.com/Met4FoF/agentMET4FOF/graphs/contributors.
+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
+
+**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 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.
diff --git a/docs/CONTRIBUTING.md → CONTRIBUTING.md b/docs/CONTRIBUTING.md → CONTRIBUTING.md
@@ -1,11 +1,23 @@
-# How to contribute to agentMET4FOF
-
-If you want to contribute back to the project, we provide a guide to get the desired
-system configuration aligned with our development environments. The code you produce
-should be seamlessly integrable into agentMET4FOF by aligning your work with the
-established workflows. This guide should work on all platforms and provide everything
-needed to start developing for agentMET4FOF. Please open an issue or ideally contribute
-to this guide as a start, if problems or questions arise.
+# Contribute to agentMET4FOF
+
+Whenever you are involved with agentMET4FOF, please respect our [Code of Conduct
+](https://github.com/Met4FoF/agentMET4FOF/blob/develop/CODE_OF_CONDUCT.md).
+If you want to contribute back to the project, after reading our Code of Conduct,
+take a look at our open developments in the [project board
+](https://github.com/Met4FoF/agentMET4FOF/projects/1), [pull requests
+](https://github.com/Met4FoF/agentMET4FOF/pulls) and search [the issues
+](https://github.com/Met4FoF/agentMET4FOF/issues). If you find something similar to
+your ideas or troubles, let us know by leaving a comment or remark. If you have
+something new to tell us, feel free to open a feature request or bug report in the
+issues.
+
+If you want to contribute code or improve our documentation, we provide this 
+guide to get the desired system configuration aligned with our development 
+environments. The code you produce should be seamlessly integrable into agentMET4FOF 
+by aligning your work with the established workflows. This guide should work on all 
+platforms and provide everything needed to start developing for agentMET4FOF. Please 
+open an issue or ideally contribute to this guide as a start, if problems or 
+questions arise.
 
 ## Guiding principles
 

diff --git a/README.md b/README.md
@@ -22,6 +22,9 @@
   <!-- Zenodo DOI -->
   <a href="https://doi.org/10.5281/zenodo.4560343">
     <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4560343.svg" alt="DOI"></a>
+  <!-- Contributor Covenant -->
+  <a href="https://github.com/Met4FoF/agentMET4FOF/blob/develop/CODE_OF_CONDUCT.md">
+    <img src="https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg" alt="Contributor Covenant"></a>
 </p>
 
 <h1 align="center">Multi-Agent System for IIoT</h1>
@@ -33,13 +36,28 @@ applications in mind. More on the motivation that drives the project can be foun
 in the section <!--suppress HtmlUnknownAnchorTarget --><a href="#about">About</a>.
 </p>
 
+### Key facts
+
+- [FOSS project](#contributing)
+- allows to
+  - quickly set up and run a [metrologically enabled multi-agent system](#about)
+  - [handle both static data sets and online data streams](#tutorials)
+  - [consider measurement uncertainties as well as metadata with the provided message system](#tutorials)
+- [installable as a Python package or ready-to-deploy Docker image](#installation)
+- comes bundled with [several introductary and advanced tutorials](#tutorials)
+- accompanied by [several use cases with close-to-industry IIoT applications in 
+  our GitHub organisation](https://github.com/Met4FoF?q=agentMET4FOF&type=&language=&sort=)
+- comprehensive and ever-growing [documentation](#documentation-and-screencasts)
+
 ## Table of content
 
 - [💫 Quickstart](#quickstart)
 - [💬 About](#about)
 - [📈 The agentMET4FOF dashboard](#the-agentmet4fof-dashboard)
-- [📖 Documentation and video tutorials](#documentation-and-video-tutorials)
+- [🤓 Tutorials](#tutorials)
+- [📖 Documentation and screencasts](#documentation-and-screencasts)
 - [💻 Installation](#installation)
+- [🐝 Contributing](#contributing)
 - [💨 Coming soon](#coming-soon)
 - [🖋 Citation](#citation)
 - [💎 Acknowledgement](#acknowledgement)
@@ -48,8 +66,9 @@ in the section <!--suppress HtmlUnknownAnchorTarget --><a href="#about">About</a
 
 ## 💫Quickstart
 
-agentMET4FOF comes bundled with some tutorials to get you started as quick as
-possible. In your Python console execute the following to run the first tutorial.
+agentMET4FOF comes bundled with several [tutorials](#tutorials) to get you started 
+as quick as possible. In your Python console execute the following to run the first 
+tutorial.
 
 ```python
 >>> from agentMET4FOF_tutorials.tutorial_1_generator_agent import demonstrate_generator_agent_use
@@ -62,12 +81,12 @@ Broadcast server running on 0.0.0.0:9091
 NS running on 127.0.0.1:3333 (127.0.0.1)
 URI = PYRO:[email protected]:3333
 
---------------------------------------------------------------
-|                                                            |
-| Your agent network is starting up. Open your browser and   |
-| visit the agentMET4FOF dashboard on http://127.0.0.1:8050/ |
-|                                                            |
---------------------------------------------------------------
+|----------------------------------------------------------|
+|                                                          |
+| Your agent network is starting up. Open your browser and |
+| visit the agentMET4FOF dashboard on http://0.0.0.0:8050/ |
+|                                                          |
+|----------------------------------------------------------|
 
 INFO [2021-02-05 18:12:52.277759] (SineGeneratorAgent_1): INITIALIZED
 INFO [2021-02-05 18:12:52.302862] (MonitorAgent_1): INITIALIZED
@@ -142,15 +161,29 @@ tutorial 2. For details on the tutorials visit our
 
 ![](https://raw.githubusercontent.com/Met4FoF/agentMET4FOF/develop/docs/screenshot_met4fof.png)
 
-## 📖Documentation and video tutorials
+## 🤓Tutorials
+
+As mentioned above, agentMET4FOF comes bundled with several [tutorials
+](https://agentmet4fof.readthedocs.io/en/latest/tutorials.html) to 
+get you started as quick as possible. You will find tutorials on how to set up:
+
+- [a simple pipeline to plot a signal](https://agentmet4fof.readthedocs.io/en/latest/agentMET4FOF_tutorials/tutorial_1_generator_agent.html)
+- [a simple pipeline with signal postprocessing](https://agentmet4fof.readthedocs.io/en/latest/agentMET4FOF_tutorials/tutorial_2_math_agent.html)
+- [an advanced pipeline with multichannel signals](https://agentmet4fof.readthedocs.io/en/latest/agentMET4FOF_tutorials/tutorial_3_multi_channel.html)
+- [a simple metrological datastream](https://agentmet4fof.readthedocs.io/en/latest/agentMET4FOF_tutorials/tutorial_4_metrological_streams.html)
+- [pipelines to determine redundancy in sensor networks](https://agentmet4fof.readthedocs.io/en/latest/tutorials.html#working-with-signals-carrying-redundant-information)
+
+… and [more](https://agentmet4fof.readthedocs.io/en/latest/tutorials.html)!
+
+## 📖Documentation and screencasts
 
 Extended
 [documentation can be found on ReadTheDocs](https://agentmet4fof.readthedocs.io).
 
-### Video tutorial series
+### Screencast series
 
 Additionally, we provide some
-[video tutorials based on agentMET4FOF 0.4.1 on the project homepage
+[screencasts based on agentMET4FOF 0.4.1 on the project homepage
 ](https://www.ptb.de/empir2018/met4fof/information-communication/video-portal/)
 in the section _Tutorials for the multi-agent system agentMET4FOF_. 
 You can self-register on the linked page and get started immediately. The video series
@@ -185,6 +218,20 @@ we guide you through every step of option 1. More detailed instructions on both
 options you can find in the [installation 
 section of the docs](https://agentmet4fof.readthedocs.io/en/latest/INSTALL.html).
 
+## 🐝Contributing
+
+Whenever you are involved with agentMET4FOF, please respect our [Code of Conduct
+](https://github.com/Met4FoF/agentMET4FOF/blob/develop/CODE_OF_CONDUCT.md).
+If you want to contribute back to the project, after reading our Code of Conduct,
+take a look at our open developments in the [project board
+](https://github.com/Met4FoF/agentMET4FOF/projects/1), [pull requests
+](https://github.com/Met4FoF/agentMET4FOF/pulls) and search [the issues
+](https://github.com/Met4FoF/agentMET4FOF/issues). If you find something similar to
+your ideas or troubles, let us know by leaving a comment or remark. If you have
+something new to tell us, feel free to open a feature request or bug report in the
+issues. If you want to contribute code or improve our documentation, please check our
+[contributing guide](https://agentmet4fof.readthedocs.io/en/latest/CONTRIBUTING.html).
+
 ## 💨Coming soon
 
 - Improved handling of metadata

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -150,7 +150,7 @@ We assume you are confident in using Nginx in general. The corresponding
 configuration should contain the following server blocks to ensure the Jupyter
 Notebook server is working, as well as the dashboard
 
-```nginx
+```text
 server {
         server_name agent.domain.com;
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -90,20 +90,15 @@
 # Copy over examples and tutorials and all other folders to docs' source
 # This makes it so that nbsphinx can properly load the notebook images
 
-# Copy over README.md from root folder.
-shutil.copyfile(
-    os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "README.md")),
-    os.path.join(os.path.dirname(__file__), "README.md"),
-)
-# Copy over CHANGELOG from root folder.
-shutil.copyfile(
-    os.path.abspath(os.path.join(os.path.dirname(__file__), "..", "CHANGELOG.md")),
-    os.path.join(os.path.dirname(__file__), "CHANGELOG.md"),
-)
-
-# Copy over all other specified folders from repository tree.
+md_files_from_root_into_docs = {"README.md", "CHANGELOG.md", "CONTRIBUTING.md"}
 
+for file_from_root in md_files_from_root_into_docs:
+    shutil.copyfile(
+        os.path.abspath(os.path.join(os.path.dirname(__file__), "..", file_from_root)),
+        os.path.join(os.path.dirname(__file__), file_from_root),
+    )
 
+# Copy over all other specified folders from repository tree.
 def make_path_dict(source: str, destination: str) -> dict:
     # Function to construct the desired dict structure for the folders to copy.
     return {"source": source, "destination": destination}