From 17e67928724e9a1e18fb8677dfdc558ac24f4137 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:01:52 +0100 Subject: [PATCH 01/10] Create SECURITY.md --- SECURITY.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..aea4b09 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,12 @@ +# Security Policy +## Reporting a Vulnerability + + + +To report a security issue, please email [SimulationEnquiries@uwl.ac.uk](mailto:simulationenquiries@uwl.ac.uk) with a description of the issue, the steps you took to create the issue, affected versions, and, if known, mitigations for the issue. This project follows a 90 day disclosure timeline. From 15f3dbfaa2235f8a25e59e72ed78db57cff97e5b Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:03:15 +0100 Subject: [PATCH 02/10] Create dependabot.yml --- .github/workflows/dependabot.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/workflows/dependabot.yml diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml new file mode 100644 index 0000000..ac6621f --- /dev/null +++ b/.github/workflows/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" From 1195eb6ccd1ed7afd1cb9c462320f55e53378573 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:04:24 +0100 Subject: [PATCH 03/10] Rename .github/workflows/dependabot.yml to .github/dependabot.yml --- .github/{workflows => }/dependabot.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{workflows => }/dependabot.yml (100%) diff --git a/.github/workflows/dependabot.yml b/.github/dependabot.yml similarity index 100% rename from .github/workflows/dependabot.yml rename to .github/dependabot.yml From adef9aafefd63fcd7936c663719146c8031fadb7 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:16:00 +0100 Subject: [PATCH 04/10] Create CHANGELOG.md --- CHANGELOG.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..162cd71 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,26 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + +## [Unreleased](https://github.com/UWLSimulationCentre/eMORA/compare/...HEAD) + +### Added + +- SECURITY.md +- Dependabot + +### Changed + +- README.md badges & other documentation + +### Removed + +- ... + +## [eMORA ILP 1.0.0](https://github.com/UWLSimulationCentre/eMORA/releases/tag/eMORA-ILP-1.0.0) - 2023-09-06 + +### Added +- Initial Release +- Implementation of Jekyll From 87696d6c6c1cb19e378846549cea49eab73b8d64 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:17:49 +0100 Subject: [PATCH 05/10] Create CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 132 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..4c6686e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,132 @@ +# 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, 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 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 +[SimulationEnquiries@uwl.ac.uk](mailto:simulationenquiries@uwl.ac.uk). +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 From 5283a75a9226ed45a6084c56f9d815bdc0f5d025 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:18:03 +0100 Subject: [PATCH 06/10] Update CHANGELOG.md --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 162cd71..b033bdb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). - SECURITY.md - Dependabot +- CODE_OF_CONDUCT.md ### Changed From 88bf04ff1454ace58f021533a0759f7b6f9f36d1 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:18:49 +0100 Subject: [PATCH 07/10] Create CONTRIBUTING.md --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..60303d0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. From da1c65b255f9d62953cc9066f1f664a4638b1d51 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:26:55 +0100 Subject: [PATCH 08/10] Update CHANGELOG.md --- CHANGELOG.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b033bdb..51c6ebe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,20 +8,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). ### Added -- SECURITY.md -- Dependabot -- CODE_OF_CONDUCT.md +- SECURITY.md [`17e6792`](https://github.com/UWLSimulationCentre/eMORA/commit/17e67928724e9a1e18fb8677dfdc558ac24f4137) +- Implemented Dependabot [`15f3dbf`](https://github.com/UWLSimulationCentre/eMORA/commit/15f3dbfaa2235f8a25e59e72ed78db57cff97e5b) +- CODE_OF_CONDUCT.md [`87696d6`](https://github.com/UWLSimulationCentre/eMORA/commit/87696d6c6c1cb19e378846549cea49eab73b8d64) +- CONTRIBUTING.md [`88bf04f`](https://github.com/UWLSimulationCentre/eMORA/commit/88bf04ff1454ace58f021533a0759f7b6f9f36d1) ### Changed -- README.md badges & other documentation - -### Removed - -- ... +- Updated README and implemented badges [`cda6e75`](https://github.com/UWLSimulationCentre/eMORA/commit/cda6e750cd3aa88cdc40757090d9785e7cb61932) ## [eMORA ILP 1.0.0](https://github.com/UWLSimulationCentre/eMORA/releases/tag/eMORA-ILP-1.0.0) - 2023-09-06 ### Added -- Initial Release -- Implementation of Jekyll +- 🌱 Initial Release From 489b22988a2760b7a8e258c2742531f5ff7affb1 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:29:48 +0100 Subject: [PATCH 09/10] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e5b2da..0c38e07 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ -[![](https://camo.githubusercontent.com/329ec7ff9e02aa4d3ecb0c491b967676c87f9db43d197a0010990e211ae24925/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f706f776572656425323062792d4a656b796c6c2d626c75652e737667)](https://jekyllrb.com/) ![](https://img.shields.io/github/contributors/UWLSimulationCentre/eMORA) ![](https://img.shields.io/github/last-commit/UWLSimulationCentre/eMORA) ![](https://img.shields.io/github/languages/top/UWLSimulationCentre/eMORA) ![](https://img.shields.io/github/issues/UWLSimulationCentre/eMORA) ![](https://img.shields.io/website?url=https%3A%2F%2Fuwlsimulationcentre.github.io%2FeMORA%2F&label=Project%20Status -) +![](https://i.imgur.com/Hoq8m18.png) +![](https://camo.githubusercontent.com/329ec7ff9e02aa4d3ecb0c491b967676c87f9db43d197a0010990e211ae24925/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f706f776572656425323062792d4a656b796c6c2d626c75652e737667) +![](https://img.shields.io/github/contributors/UWLSimulationCentre/eMORA) +![](https://img.shields.io/github/last-commit/UWLSimulationCentre/eMORA) +![](https://img.shields.io/github/languages/top/UWLSimulationCentre/eMORA) +![](https://img.shields.io/github/issues/UWLSimulationCentre/eMORA) +![](https://img.shields.io/website?url=https%3A%2F%2Fuwlsimulationcentre.github.io%2FeMORA%2F&label=Project%20Status) + # eMORA System Instructional Package From a93d9875a9f01722facaf42c7040a38350c6cc79 Mon Sep 17 00:00:00 2001 From: Sam <108990188+smcnab1@users.noreply.github.com> Date: Thu, 7 Sep 2023 14:30:11 +0100 Subject: [PATCH 10/10] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 0c38e07..5d75ca0 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ ![](https://camo.githubusercontent.com/329ec7ff9e02aa4d3ecb0c491b967676c87f9db43d197a0010990e211ae24925/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f706f776572656425323062792d4a656b796c6c2d626c75652e737667) ![](https://img.shields.io/github/contributors/UWLSimulationCentre/eMORA) ![](https://img.shields.io/github/last-commit/UWLSimulationCentre/eMORA) -![](https://img.shields.io/github/languages/top/UWLSimulationCentre/eMORA) ![](https://img.shields.io/github/issues/UWLSimulationCentre/eMORA) ![](https://img.shields.io/website?url=https%3A%2F%2Fuwlsimulationcentre.github.io%2FeMORA%2F&label=Project%20Status)