diff --git a/ARCH.md b/ARCH.md
deleted file mode 100644
index 0bcc4bdad99fa5061401334bd278cc187771de8a..0000000000000000000000000000000000000000
--- a/ARCH.md
+++ /dev/null
@@ -1,5 +0,0 @@
-
-# Architecture
-
-TODO
-
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000000000000000000000000000000000000..3193c5099e9126fc81170a03f1b78b86b2ad0269
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,4 @@
+
+# CHANGELOG
+
+TODO
diff --git a/CONDUCT.md b/CONDUCT.md
new file mode 100644
index 0000000000000000000000000000000000000000..5fd6a5304d3c4913cd280511896b7ef94c5bc13c
--- /dev/null
+++ b/CONDUCT.md
@@ -0,0 +1,4 @@
+
+# Code of Conduct
+
+TODO
diff --git a/CREDITS.md b/CREDITS.md
index 96450180c378de1bea4713b5aff486c01930578d..f886ac6d16f36d105e523e7b2dd1014144a5d7d9 100644
--- a/CREDITS.md
+++ b/CREDITS.md
@@ -3,3 +3,7 @@
TODO
+[Shields.IO](https://shields.io/)
+
+[Markdown License badges](https://gist.github.com/lukas-h/2a5d00690736b4c3a7ba)
+
diff --git a/INSTALL.md b/INSTALL.md
deleted file mode 100644
index 73c4f62c76f8ebc6ba087607e7d72bac251566b8..0000000000000000000000000000000000000000
--- a/INSTALL.md
+++ /dev/null
@@ -1,5 +0,0 @@
-
-# Installation
-
-MISSING
-
diff --git a/README.md b/README.md
index 2ec20efd620165bfa3fb3c0ee0d74c927e45dd89..9132521fb6ab3eb1953fd669ae7405b3f9c06955 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,11 @@
[](https://opensource.org/licenses/MIT)
+[](https://creativecommons.org/licenses/by/4.0/)
+[](https://gitlab.cci.drexel.edu/courseeval/team-blue)
[ cs.drexel.edu](https://www.cs.drexel.edu/)
-# [](https://gitlab.cci.drexel.edu/courseeval/team-blue)
-(MISSING TAGLINE)
+# [](https://gitlab.cci.drexel.edu/courseeval/team-blue)
+A student project to learn FOSS contributing practices.
## Contents
@@ -12,9 +14,7 @@
- [Getting Started](#getting-started)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- - [Architecture](#architecture)
- - [Prerequisites](#prerequisites)
- - [Installation](#installation)
+ - [Guidelines](#guidelines)
- [Accepting Changes](#accepting-changes)
- [License](#license)
- [Contact](#contact)
@@ -24,13 +24,16 @@
## About
-A Student Study Project to develop [Course Evaluation](https://en.wikipedia.org/wiki/Course_evaluation) platform prototypes and associated design documents. By SE420 Open Source Engineering Team Blue for FA22Q2 "Winter" at [Drexel University](https://drexel.edu/).
+A Student Study Project to develop [Course Evaluation](https://en.wikipedia.org/wiki/Course_evaluation) platform prototypes and associated design documents.
+By SE420 Open Source Engineering Team Blue for FA22Q2 "Winter" at [Drexel University](https://drexel.edu/).
See [Notes](notes/readme.md) for more detailed information, including proposals.
## Getting Started
-(MISSING)
+Please join us on [Discord](https://discord.gg/QKBxxSS9), we are largely focused on *discussing* and *documenting* steps as opposed to outright *programming*.
+
+We currently do a lot of work in *Microsoft Word* and *Markdown*, so having a Microsoft account and a decent text editor is recommendable.
## Roadmap
@@ -41,40 +44,50 @@ See [**Issues**](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues) fo
## Contributing
-### Architecture
-See [`ARCH.md`](ARCH.md) to get a basic understanding of how the final project works.
-Also take a look at some of the other projects listed under [`CREDITS.md`](CREDITS.md) to get a good understanding of how the tools work.
-
-### Prerequisites
-See each Prototype folder for specific requirements.
-
-### Installation
-1. Clone the Repo
- ```bash
- git clone https://gitlab.cci.drexel.edu/courseeval/team-blue
- ```
-2. See each Prototype folder for specific steps
+### Guidelines
+Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for specifics.
### Accepting Changes
-This is a low-priority project for @peter201943 and as such pull requests are not likely to be accepted.
+This is a low-priority project and as such pull requests are not likely to be accepted.
You will be better served by forking it and continuing development of it on your own.
## License
-Code is distributed under the MIT license. Documentation is distributed under the CC-BY license. See [`LICENSE`](LICENSE) for more information.
+Code is distributed under the MIT license. Documentation is distributed under the CC-BY license. See [`LICENSE`](LICENSE.md) for more information.
## Contact
+### Project
+**CourseEval**
+[](https://discord.gg/QKBxxSS9)
+[](https://gitlab.cci.drexel.edu/courseeval/team-blue)
+[](https://github.com/peter201943/student-voice)
+
### Primary Maintainer
-Peter James Mangelsdorf
+**Peter James Mangelsdorf**
+[](https://discord.com/users/312363766954065930)
[](mailto:peter.j.mangelsdorf@outlook.com)
-[](https://discord.com/)
[](https://github.com/peter201943/)
+[](mailto:pjm349@drexel.edu)
-### Project
-[](https://discord.gg/QKBxxSS9)
+### Other Maintainers
+**Hoang Nguyen**
+[](https://discord.com/users/131543410627575808)
+[](mailto:hn374@drexel.edu)
+
+**Jay Patel**
+[](https://discord.com/users/892071574948184124)
+[](mailto:jp3592@drexel.edu)
+
+**Charles Porter**
+[](https://discord.com/users/555963456445218826)
+[](mailto:cap399@drexel.edu)
+
+**Eric Savoy**
+[](https://discord.com/users/751931130780975205)
+[](mailto:ets43@drexel.edu)
## Acknowledgements
diff --git a/notes/2022-01-26 Class.md b/notes/2022-01-26 Class.md
deleted file mode 100644
index ed3e49e6705238c4eb61f0bed7e8de805e0eb793..0000000000000000000000000000000000000000
--- a/notes/2022-01-26 Class.md
+++ /dev/null
@@ -1,5 +0,0 @@
-
-# 2022-01-26
-
-TODO
-
diff --git a/notes/2022-02-12.md b/notes/2022-02-12.md
index 073b1f4ac64ad6f12c534f46b10f2b23b9456f76..df4b313df9519f939f327a45bce93e759ad83f39 100644
--- a/notes/2022-02-12.md
+++ b/notes/2022-02-12.md
@@ -21,6 +21,9 @@
- Already scattered all over the damn place
- Need to merge - how?
- Also bear in mind use of Discord as a "temporary notes platform"
+ - - SE420 FA22Q2 Teams OneNote Notebook
+ - ~~Peter's Google Keep (In Progress Download and Transfer)~~ (No Longer Relevant/Needed)
+ - ~~Peter's Personal Notes (In Progress Transfer)~~ (No Longer Relevant/Needed)
- 7. Required Qualities of Notes
- What do people find useful/necessary?
- Ability to simultaneously edit notes online at same time has been very popular recently
@@ -89,6 +92,9 @@
- [(Example) Rust Analyzer's "Architecture"](https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/dev/architecture.md)
- [(Article) From Architectural Decisions to Design Decisions](https://medium.com/olzzio/from-architectural-decisions-to-design-decisions-f05f6d57032b)
- [(Article) Markdown Architectural Decision Records](https://github.com/adr/madr)
+- 2022-02-13T01:04:00-04:00 Peter:
+ - I have decided we will not be using any "`ARCH.md`" files as we will be contributing directly to someone else's project
+ - As such, I will put more of an emphasis on team decisions and meetings
## Change Logs
- Filename: `CHANGELOG.md`
@@ -104,6 +110,7 @@
- [(Article) "security-README", proposed standard for open source repos](https://github.com/Trewaters/security-README)
- [(Example) Gitlab's Security.Txt](https://gitlab.com/gitlab-org/gitlab/-/blob/master/security.txt)
- [(Example) NodeJS Security Policy via Dedicated Tab (GitHub)](https://github.com/nodejs/node/security/policy)
+- Given the low stakes of this project, just redirect concerns regarding code to the primary project
## Issue Templates
- Filename: `.gitlab/issue_templates/`
@@ -173,29 +180,34 @@
- [(Example) GodotEngine Bug Report Issues](https://github.com/godotengine/godot/issues) is intended more for immediate technical-issues
- [(Example) GodotEngine Feature Enhancement Issues](https://github.com/godotengine/godot-proposals/issues) is intended more for extended-discussion
- [(Example) GodotEngine developers tend to organize in an adhoc manner, primarily through text-chat](https://chat.godotengine.org/channel/general)
+- [(Article) Gitlab Badges](https://docs.gitlab.com/ee/user/project/badges.html)
+- GitLab does not support badges on private instances (the `gitlab.cci.drexel.edu` instance as example)
+- Will just use regular badges as result
## New Directory Structure
```yaml
team-blue/:
.gitlab/issue_templates/:
- code-bug-report.md
- code-feature-request.md
- team-bug-report.md
- team-feature-request.md
+ bug-report.md
+ class-assignment.md
+ documentation.md
+ external-interaction.md
+ proposal.md
+ team-process.md
docs/:
decisions/:
+ 0001-use-decisions-as-docs.md
discussions/:
- architecture.md
- changelog.md
+ 2022-02-12.md
conduct.md
contributing.md
- decisions.md
security.md
- readme.md
resources/:
team-logo.png
drexel-logo.png
cc-by-logo.png
+ changelog.md
+ credits.md
license.md
readme.md
```
diff --git a/notes/Locations.md b/notes/Locations.md
deleted file mode 100644
index 6a7f5395317b22cc555e05ebaf1177d404ca4f38..0000000000000000000000000000000000000000
--- a/notes/Locations.md
+++ /dev/null
@@ -1,7 +0,0 @@
-
-# Alternate Note Locations
-
-- SE420 FA22Q2 Teams OneNote Notebook
-- Peter's Google Keep (In Progress Download and Transfer)
-- Peter's Personal Notes (In Progress Transfer)
-
diff --git a/notes/README.md b/notes/README.md
deleted file mode 100644
index c4528c99132688978432c87a53195baf6f64b00d..0000000000000000000000000000000000000000
--- a/notes/README.md
+++ /dev/null
@@ -1,4 +0,0 @@
-
-# Notes
-
-[Open this Folder in **Obsidian**](https://obsidian.md/)