From 8b94d6ff4e577ae2a3b0e5c18077b7ba184a4510 Mon Sep 17 00:00:00 2001 From: Maximilian Anzinger <44003963+MaximilianAnzinger@users.noreply.github.com> Date: Mon, 18 Nov 2024 23:41:46 +0100 Subject: [PATCH] Development: Add general markdown files (#8) --- CITATION.cff | 34 ++++++++++++ CODE_OF_CONDUCT.md | 132 +++++++++++++++++++++++++++++++++++++++++++++ README.md | 55 +++++++++++++++++++ SECURITY.md | 10 ++++ 4 files changed, 231 insertions(+) create mode 100644 CITATION.cff create mode 100644 CODE_OF_CONDUCT.md create mode 100644 README.md create mode 100644 SECURITY.md diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 0000000..5d59170 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,34 @@ +cff-version: 1.2.0 +message: "If you cite this project, please use the following citation." +authors: + - + affiliation: "Technical University of Munich" + family-names: Anzinger + given-names: Maximilian + orcid: "0009-0000-7378-6292" + - + affiliation: "Technical University of Munich" + family-names: Krusche + given-names: Stephan + orcid: "0000-0002-4552-644X" +title: "Atlas: Adaptive Competency-Based Learning" +version: 0.0.0 +date-released: 2024-11-18 +license: MIT +repository-code: "https://github.com/ls1intum/atlas" +preferred-citation: + type: data + authors: + - + affiliation: "Technical University of Munich" + family-names: Anzinger + given-names: Maximilian + orcid: "0009-0000-7378-6292" + - + affiliation: "Technical University of Munich" + family-names: Krusche + given-names: Stephan + orcid: "0000-0002-4552-644X" + title: "Atlas: Adaptive Competency-Based Learning" + doi: "10.5281/zenodo.14045625" + year: 2024 \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..fd83bb3 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# Atlas 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, caste, color, 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 email 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 +[INSERT CONTACT METHOD]. +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.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/README.md b/README.md new file mode 100644 index 0000000..2d758aa --- /dev/null +++ b/README.md @@ -0,0 +1,55 @@ +# **Atlas: Adaptive Competency-Based Learning** + +Atlas is a microservice designed to seamlessly incorporate competency models into Learning Management Systems (LMS). By leveraging cutting-edge machine learning and generative AI (GenAI/LLMs), Atlas empowers educators to create sophisticated competency models, fostering more effective teaching methods and improving student learning outcomes. + +--- + +## **Why Atlas?** + +Competency-based education (CBE) is a proven method for enhancing learning, but its implementation can be complex and time-consuming. Atlas addresses this challenge by automating and simplifying the creation of high-quality competency models, including: +- Automatically generated relationships between competencies. +- Recommendations for linking competencies to relevant learning activities. + +--- + +## **Key Features** +- **AI-Powered Competency Models**: Generate and recommend sophisticated competency models with minimal effort. +- **Seamless LMS Integration**: Works with Artemis and can be adapted to other LMSs. +- **Open Source**: Freely accessible to the community under the [MIT license](https://github.com/ls1intum/Atlas?tab=MIT-1-ov-file). +- **Planned API & Micro Frontend**: Future enhancements will allow for broader flexibility and easier interaction. + +--- + +## **Installation** + +Detailed installation instructions can be found in the [documentation](#). + +--- + +## **Usage** + +To get started with Atlas and explore its features, refer to the [user guide](#) in the documentation. + +--- + +## **Contributing** + +We welcome contributions to improve Atlas! Please follow the [contribution guidelines](#) outlined in the documentation. + +--- + +## **Support** + +For issues or questions, please use the [GitHub Issues](https://github.com/ls1intum/Atlas/issues) section of this repository. + +--- + +## **License** + +This project is licensed under the MIT License. See the LICENSE file for details. + +--- + +## **Acknowledgments** + +Atlas is currently integrated with Artemis but is designed to adapt to other LMS platforms, making it versatile for a wide range of educational environments. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..cba1e3c --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,10 @@ +# Security Policy + +## Supported Versions + +Currently, only the latest version of Atlas is supported. +We do **not** provide security patches for older versions. + +## Reporting a Vulnerability + +Please use [Github's security advisory feature](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing-information-about-vulnerabilities/privately-reporting-a-security-vulnerability) to report any security vulnerabilities. \ No newline at end of file