From 51a0586c58fd8260a83c4ab7a6a1af1811c412e9 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 28 Feb 2024 10:53:59 +0000 Subject: [PATCH 01/10] Bump readthedocs-sphinx-search from 0.1.1 to 0.3.2 in /docs Bumps [readthedocs-sphinx-search](https://github.com/readthedocs/readthedocs-sphinx-search) from 0.1.1 to 0.3.2. - [Changelog](https://github.com/readthedocs/readthedocs-sphinx-search/blob/main/CHANGELOG.rst) - [Commits](https://github.com/readthedocs/readthedocs-sphinx-search/compare/0.1.1...0.3.2) --- updated-dependencies: - dependency-name: readthedocs-sphinx-search dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 53d44466..3d5bdc5b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ docutils<0.18 sphinx==5.3.0 sphinx_rtd_theme==2.0.0 -readthedocs-sphinx-search==0.1.1 +readthedocs-sphinx-search==0.3.2 urllib3==1.26.13 \ No newline at end of file From 16d06bd13f1ad729dc66b99b03ae5292a85dd967 Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 29 Feb 2024 10:09:52 +0100 Subject: [PATCH 02/10] SEBSERV-507 added CONTRIBUTION.md --- CONTRIBUTION.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 1 + 2 files changed, 54 insertions(+) create mode 100644 CONTRIBUTION.md diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md new file mode 100644 index 00000000..fb0dbcc1 --- /dev/null +++ b/CONTRIBUTION.md @@ -0,0 +1,53 @@ +# Contributing to SEB Server +We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Give us a star +- Reporting a bug +- Submitting a fix +- Proposing new features +- Becoming a SEB Alliance member + +## We Develop with Github +We use github to host code, to track issues and feature requests, as well as accept pull requests. + +## We Use Git-Flow for Code Contributions +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)). We actively welcome your pull requests: + +1. Fork the repo and create your branch from `development`. The development branch always has the newest changes. +2. If you've added code that should be tested, add tests. +3. If you introduce new API also add clear documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. +6. Issue that pull request! + +## Any contributions you make will be under the Mozilla Public License Version 2.0 +In short, when you submit code changes, your submissions are understood to be under the same [Mozilla Public License](https://github.com/SafeExamBrowser/seb-server?tab=MPL-2.0-1-ov-file) that covers the project. Feel free to contact the maintainers if that's a concern. + +## Report bugs using Github's Issue +We use [Github issues](https://github.com/SafeExamBrowser/seb-server/issues) to track public bugs. Report a bug by [opening a new issue](); + +## Write bug reports with detail, background, and sample code +**Before enter a new bug-report, ensure the bug was not already reported** + +Please fill and provide all the information suggested by the bug-report template +Great Bug Reports tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. Can also be Pseudocode. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + +## Use a Consistent Coding Style +Have a close look to the existing code stile that is used within SEB Server and adapt to it as close as possible. +We reserve the right to adapt contributed code to the code style matching SEB Server code style before or after a pull request. + +## Becoming a SEB Alliance member +The [SEB Alliance](https://www.safeexambrowser.org/alliance/members.html) is the body which sustains ongoing funding of the Safe Exam Browser open source project to continue its maintenance, development and support activities. ETH Zurich provides the infrastructure for the management and the software engineering of the SEB project and appoints an alliance manager who will provide administrative support to the SEB Alliance, and ensure the day-to-day running of the SEB Alliance. ETH Zurich leads the Alliance and offers different contribution levels to parties interested in the evolution of the SEB open source project. + +More information about [joining](https://www.safeexambrowser.org/alliance/join.html) the Alliance is available in our [benefits](https://www.safeexambrowser.org/alliance/benefits.html) and [documents](https://www.safeexambrowser.org/alliance/documents.html) section. + +## License +By contributing, you agree that your contributions will be licensed under its [Mozilla Public License](https://github.com/SafeExamBrowser/seb-server?tab=MPL-2.0-1-ov-file). diff --git a/README.rst b/README.rst index 1213649d..c556a2d0 100644 --- a/README.rst +++ b/README.rst @@ -142,6 +142,7 @@ Getting started with SEB Server For a complete SEB Server user guide please go to `SEB Server User Guide `_ + Project Background ------------------ From c96c950f6e892ee4a292703386df1dd1b302d5a5 Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 29 Feb 2024 10:11:33 +0100 Subject: [PATCH 03/10] SEBSERV-507 added CONTRIBUTION.md --- CONTRIBUTION.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUTION.md => CONTRIBUTING.md (100%) diff --git a/CONTRIBUTION.md b/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTION.md rename to CONTRIBUTING.md From a9d4424368293e8f01613d1eb87b12178f0d1cad Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 29 Feb 2024 10:15:03 +0100 Subject: [PATCH 04/10] SEBSERV-507 added CONTRIBUTION.md --- CONTRIBUTING.md => CONTRIBUTING | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CONTRIBUTING.md => CONTRIBUTING (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING similarity index 100% rename from CONTRIBUTING.md rename to CONTRIBUTING From 169a709fedd2f75effc0c4481f9615ec72dc27ae Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 29 Feb 2024 10:18:22 +0100 Subject: [PATCH 05/10] SEBSERV-507 added CONTRIBUTION.md --- CONTRIBUTING => CONTRIBUTING.md | 0 README.rst | 4 ++++ 2 files changed, 4 insertions(+) rename CONTRIBUTING => CONTRIBUTING.md (100%) diff --git a/CONTRIBUTING b/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING rename to CONTRIBUTING.md diff --git a/README.rst b/README.rst index c556a2d0..f124f559 100644 --- a/README.rst +++ b/README.rst @@ -147,3 +147,7 @@ Project Background ------------------ The SEB Server is currently build and maintained by `ETH Zürich `_ and by the `Swiss MOOC Service `_ that is founded by leading Swiss universities EPFL, ETH, SUPSI, USI and HES-SO. The Swiss MOOC Service was financially supported from 2018-2020 by the `Swissuniversities´ P5 program `_. + +Contribution +------------ +.. include:: CONTRIBUTING.md From 75a56cd82964deca12cc9284c47c48473b907c53 Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 29 Feb 2024 10:19:18 +0100 Subject: [PATCH 06/10] SEBSERV-507 added CONTRIBUTION.md --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f124f559..a0a3cba6 100644 --- a/README.rst +++ b/README.rst @@ -150,4 +150,4 @@ The SEB Server is currently build and maintained by `ETH Zürich Date: Thu, 29 Feb 2024 10:29:16 +0100 Subject: [PATCH 07/10] SEBSERV-507 added CONTRIBUTION.md --- CONTRIBUTING.md | 3 --- README.rst | 58 +++++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 54 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb0dbcc1..32cf344b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,6 +48,3 @@ We reserve the right to adapt contributed code to the code style matching SEB Se The [SEB Alliance](https://www.safeexambrowser.org/alliance/members.html) is the body which sustains ongoing funding of the Safe Exam Browser open source project to continue its maintenance, development and support activities. ETH Zurich provides the infrastructure for the management and the software engineering of the SEB project and appoints an alliance manager who will provide administrative support to the SEB Alliance, and ensure the day-to-day running of the SEB Alliance. ETH Zurich leads the Alliance and offers different contribution levels to parties interested in the evolution of the SEB open source project. More information about [joining](https://www.safeexambrowser.org/alliance/join.html) the Alliance is available in our [benefits](https://www.safeexambrowser.org/alliance/benefits.html) and [documents](https://www.safeexambrowser.org/alliance/documents.html) section. - -## License -By contributing, you agree that your contributions will be licensed under its [Mozilla Public License](https://github.com/SafeExamBrowser/seb-server?tab=MPL-2.0-1-ov-file). diff --git a/README.rst b/README.rst index a0a3cba6..6dfd816a 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,7 @@ -Master: +Safe Exam Browser (SEB) Server +-------------------------------- + +Master: .. image:: https://github.com/SafeExamBrowser/seb-server/actions/workflows/buildReporting.yml/badge.svg?branch=master :target: https://github.com/SafeExamBrowser/seb-server/actions @@ -148,6 +151,53 @@ Project Background The SEB Server is currently build and maintained by `ETH Zürich `_ and by the `Swiss MOOC Service `_ that is founded by leading Swiss universities EPFL, ETH, SUPSI, USI and HES-SO. The Swiss MOOC Service was financially supported from 2018-2020 by the `Swissuniversities´ P5 program `_. -Contribution ------------- -.. include:: ./CONTRIBUTING.md +Contributing to SEB Server +------------------ +We want to make contributing to this project as easy and transparent as possible, whether it's: + +- Give us a star +- Reporting a bug +- Submitting a fix +- Proposing new features +- Becoming a SEB Alliance member + +We use github to host code, to track issues and feature requests, as well as accept pull requests. +And we use [Github issues](https://github.com/SafeExamBrowser/seb-server/issues) to track public bugs. +Report a bug by [opening a new issue](); + +**Before enter a new bug-report, ensure the bug was not already reported** +Please fill and provide all the information suggested by the bug-report template +Great Bug Reports tend to have: + +- A quick summary and/or background +- Steps to reproduce + - Be specific! + - Give sample code if you can. Can also be Pseudocode. +- What you expected would happen +- What actually happens +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) + +** We Use Git-Flow for Code Contributions** +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)). We actively welcome your pull requests: + +1. Fork the repo and create your branch from `development`. The development branch always has the newest changes. +2. If you've added code that should be tested, add tests. +3. If you introduce new API also add clear documentation. +4. Ensure the test suite passes. +5. Make sure your code lints. +6. Issue that pull request! + +**Use a Consistent Coding Style** + +Have a close look to the existing code stile that is used within SEB Server and adapt to it as close as possible. +We reserve the right to adapt contributed code to the code style matching SEB Server code style before or after a pull request. + +**Any contributions you make will be under the Mozilla Public License Version 2.0** + +In short, when you submit code changes, your submissions are understood to be under the same [Mozilla Public License](https://github.com/SafeExamBrowser/seb-server?tab=MPL-2.0-1-ov-file) that covers the project. Feel free to contact the maintainers if that's a concern. + +**Becoming a SEB Alliance member** +The [SEB Alliance](https://www.safeexambrowser.org/alliance/members.html) is the body which sustains ongoing funding of the Safe Exam Browser open source project to continue its maintenance, development and support activities. ETH Zurich provides the infrastructure for the management and the software engineering of the SEB project and appoints an alliance manager who will provide administrative support to the SEB Alliance, and ensure the day-to-day running of the SEB Alliance. ETH Zurich leads the Alliance and offers different contribution levels to parties interested in the evolution of the SEB open source project. + +More information about [joining](https://www.safeexambrowser.org/alliance/join.html) the Alliance is available in our [benefits](https://www.safeexambrowser.org/alliance/benefits.html) and [documents](https://www.safeexambrowser.org/alliance/documents.html) section. + From 613860aaa7c78bb1eaf8b6baa428b9887b4cb67b Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 29 Feb 2024 10:35:41 +0100 Subject: [PATCH 08/10] SEBSERV-507 added CONTRIBUTION.md --- README.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 6dfd816a..be1d7ee6 100644 --- a/README.rst +++ b/README.rst @@ -162,23 +162,24 @@ We want to make contributing to this project as easy and transparent as possible - Becoming a SEB Alliance member We use github to host code, to track issues and feature requests, as well as accept pull requests. -And we use [Github issues](https://github.com/SafeExamBrowser/seb-server/issues) to track public bugs. +And we use `Github issues `_ to track public bugs. Report a bug by [opening a new issue](); **Before enter a new bug-report, ensure the bug was not already reported** + Please fill and provide all the information suggested by the bug-report template Great Bug Reports tend to have: - A quick summary and/or background - Steps to reproduce - - Be specific! - - Give sample code if you can. Can also be Pseudocode. +- Be specific and give sample code if you can. Can also be Pseudocode. - What you expected would happen - What actually happens - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) ** We Use Git-Flow for Code Contributions** -Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)). We actively welcome your pull requests: + +Pull requests are the best way to propose changes to the codebase. We use `Github Flow `_. We actively welcome your pull requests: 1. Fork the repo and create your branch from `development`. The development branch always has the newest changes. 2. If you've added code that should be tested, add tests. @@ -194,10 +195,10 @@ We reserve the right to adapt contributed code to the code style matching SEB Se **Any contributions you make will be under the Mozilla Public License Version 2.0** -In short, when you submit code changes, your submissions are understood to be under the same [Mozilla Public License](https://github.com/SafeExamBrowser/seb-server?tab=MPL-2.0-1-ov-file) that covers the project. Feel free to contact the maintainers if that's a concern. +In short, when you submit code changes, your submissions are understood to be under the same `Mozilla Public License `_ that covers the project. Feel free to contact the maintainers if that's a concern. **Becoming a SEB Alliance member** -The [SEB Alliance](https://www.safeexambrowser.org/alliance/members.html) is the body which sustains ongoing funding of the Safe Exam Browser open source project to continue its maintenance, development and support activities. ETH Zurich provides the infrastructure for the management and the software engineering of the SEB project and appoints an alliance manager who will provide administrative support to the SEB Alliance, and ensure the day-to-day running of the SEB Alliance. ETH Zurich leads the Alliance and offers different contribution levels to parties interested in the evolution of the SEB open source project. +The `SEB Alliance `_ is the body which sustains ongoing funding of the Safe Exam Browser open source project to continue its maintenance, development and support activities. ETH Zurich provides the infrastructure for the management and the software engineering of the SEB project and appoints an alliance manager who will provide administrative support to the SEB Alliance, and ensure the day-to-day running of the SEB Alliance. ETH Zurich leads the Alliance and offers different contribution levels to parties interested in the evolution of the SEB open source project. -More information about [joining](https://www.safeexambrowser.org/alliance/join.html) the Alliance is available in our [benefits](https://www.safeexambrowser.org/alliance/benefits.html) and [documents](https://www.safeexambrowser.org/alliance/documents.html) section. +More information about `joining `_ the Alliance is available in our `benefits `_ and `documents `_ section. From 071effbaaf073788a81f13425eab37523ce8503b Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 29 Feb 2024 10:37:17 +0100 Subject: [PATCH 09/10] SEBSERV-507 added CONTRIBUTION.md --- README.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index be1d7ee6..ffd1c873 100644 --- a/README.rst +++ b/README.rst @@ -177,7 +177,7 @@ Great Bug Reports tend to have: - What actually happens - Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) -** We Use Git-Flow for Code Contributions** +**We Use Git-Flow for Code Contributions** Pull requests are the best way to propose changes to the codebase. We use `Github Flow `_. We actively welcome your pull requests: @@ -198,6 +198,7 @@ We reserve the right to adapt contributed code to the code style matching SEB Se In short, when you submit code changes, your submissions are understood to be under the same `Mozilla Public License `_ that covers the project. Feel free to contact the maintainers if that's a concern. **Becoming a SEB Alliance member** + The `SEB Alliance `_ is the body which sustains ongoing funding of the Safe Exam Browser open source project to continue its maintenance, development and support activities. ETH Zurich provides the infrastructure for the management and the software engineering of the SEB project and appoints an alliance manager who will provide administrative support to the SEB Alliance, and ensure the day-to-day running of the SEB Alliance. ETH Zurich leads the Alliance and offers different contribution levels to parties interested in the evolution of the SEB open source project. More information about `joining `_ the Alliance is available in our `benefits `_ and `documents `_ section. From 73aeda28a3bf67cd81f1f2bf9610ec1c5c77c4ac Mon Sep 17 00:00:00 2001 From: anhefti Date: Thu, 29 Feb 2024 10:38:42 +0100 Subject: [PATCH 10/10] SEBSERV-507 added CONTRIBUTION.md --- CONTRIBUTING.md | 50 ------------------------------------------------- 1 file changed, 50 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 32cf344b..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,50 +0,0 @@ -# Contributing to SEB Server -We want to make contributing to this project as easy and transparent as possible, whether it's: - -- Give us a star -- Reporting a bug -- Submitting a fix -- Proposing new features -- Becoming a SEB Alliance member - -## We Develop with Github -We use github to host code, to track issues and feature requests, as well as accept pull requests. - -## We Use Git-Flow for Code Contributions -Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)). We actively welcome your pull requests: - -1. Fork the repo and create your branch from `development`. The development branch always has the newest changes. -2. If you've added code that should be tested, add tests. -3. If you introduce new API also add clear documentation. -4. Ensure the test suite passes. -5. Make sure your code lints. -6. Issue that pull request! - -## Any contributions you make will be under the Mozilla Public License Version 2.0 -In short, when you submit code changes, your submissions are understood to be under the same [Mozilla Public License](https://github.com/SafeExamBrowser/seb-server?tab=MPL-2.0-1-ov-file) that covers the project. Feel free to contact the maintainers if that's a concern. - -## Report bugs using Github's Issue -We use [Github issues](https://github.com/SafeExamBrowser/seb-server/issues) to track public bugs. Report a bug by [opening a new issue](); - -## Write bug reports with detail, background, and sample code -**Before enter a new bug-report, ensure the bug was not already reported** - -Please fill and provide all the information suggested by the bug-report template -Great Bug Reports tend to have: - -- A quick summary and/or background -- Steps to reproduce - - Be specific! - - Give sample code if you can. Can also be Pseudocode. -- What you expected would happen -- What actually happens -- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) - -## Use a Consistent Coding Style -Have a close look to the existing code stile that is used within SEB Server and adapt to it as close as possible. -We reserve the right to adapt contributed code to the code style matching SEB Server code style before or after a pull request. - -## Becoming a SEB Alliance member -The [SEB Alliance](https://www.safeexambrowser.org/alliance/members.html) is the body which sustains ongoing funding of the Safe Exam Browser open source project to continue its maintenance, development and support activities. ETH Zurich provides the infrastructure for the management and the software engineering of the SEB project and appoints an alliance manager who will provide administrative support to the SEB Alliance, and ensure the day-to-day running of the SEB Alliance. ETH Zurich leads the Alliance and offers different contribution levels to parties interested in the evolution of the SEB open source project. - -More information about [joining](https://www.safeexambrowser.org/alliance/join.html) the Alliance is available in our [benefits](https://www.safeexambrowser.org/alliance/benefits.html) and [documents](https://www.safeexambrowser.org/alliance/documents.html) section.