Skip to content
Snippets Groups Projects
Commit 14de6cd1 authored by Peter Mangelsdorf's avatar Peter Mangelsdorf
Browse files

remove unneeded ARCH; remove unneeded INSTALL; remove blank class notes;...

remove unneeded ARCH; remove unneeded INSTALL; remove blank class notes; remove unneeded docs README; remove unneeded LOCATIONS; added blank CHANGELOG; added blank CONDUCT; significantly improved README; added some recent credits to CREDITS; added significantly more notes regarding labels and project structure
parent 1682d832
Branches
No related tags found
No related merge requests found
# Architecture
TODO
# 2022-01-26 # CHANGELOG
TODO TODO
# Code of Conduct
TODO
...@@ -3,3 +3,7 @@ ...@@ -3,3 +3,7 @@
TODO TODO
[Shields.IO](https://shields.io/)
[Markdown License badges](https://gist.github.com/lukas-h/2a5d00690736b4c3a7ba)
# Installation
MISSING
[![MIT License](https://img.shields.io/github/license/peter201943/student-voice.svg?style=flat)](https://opensource.org/licenses/MIT) [![MIT License](https://img.shields.io/github/license/peter201943/student-voice.svg?style=flat)](https://opensource.org/licenses/MIT)
[![License: CC BY 4.0](https://licensebuttons.net/l/by/4.0/80x15.png)](https://creativecommons.org/licenses/by/4.0/)
[![GitLab](https://img.shields.io/badge/github-%23121011.svg?style=flat&logo=gitlab&logoColor=white&label=CourseEval)](https://gitlab.cci.drexel.edu/courseeval/team-blue)
[![Drexel](resources/drexel-logo.svg) cs.drexel.edu](https://www.cs.drexel.edu/) [![Drexel](resources/drexel-logo.svg) cs.drexel.edu](https://www.cs.drexel.edu/)
# [![StudentVoice](resources/title.png)](https://gitlab.cci.drexel.edu/courseeval/team-blue) # [![CourseEval](resources/title.png)](https://gitlab.cci.drexel.edu/courseeval/team-blue)
(MISSING TAGLINE) A student project to learn FOSS contributing practices.
## Contents ## Contents
...@@ -12,9 +14,7 @@ ...@@ -12,9 +14,7 @@
- [Getting Started](#getting-started) - [Getting Started](#getting-started)
- [Roadmap](#roadmap) - [Roadmap](#roadmap)
- [Contributing](#contributing) - [Contributing](#contributing)
- [Architecture](#architecture) - [Guidelines](#guidelines)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Accepting Changes](#accepting-changes) - [Accepting Changes](#accepting-changes)
- [License](#license) - [License](#license)
- [Contact](#contact) - [Contact](#contact)
...@@ -24,13 +24,16 @@ ...@@ -24,13 +24,16 @@
## About ## 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. See [Notes](notes/readme.md) for more detailed information, including proposals.
## Getting Started ## 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 ## Roadmap
...@@ -41,40 +44,50 @@ See [**Issues**](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues) fo ...@@ -41,40 +44,50 @@ See [**Issues**](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues) fo
## Contributing ## Contributing
### Architecture ### Guidelines
See [`ARCH.md`](ARCH.md) to get a basic understanding of how the final project works. Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for specifics.
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
### Accepting Changes ### 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. You will be better served by forking it and continuing development of it on your own.
## License ## 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.
![](resources/cc-by-logo.png) ![](resources/cc-by-logo.png)
## Contact ## Contact
### Project
**CourseEval**
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=SE420%2FFA22Q2)](https://discord.gg/QKBxxSS9)
[![GitLab](https://img.shields.io/badge/github-%23121011.svg?style=flat&logo=gitlab&logoColor=white&label=CourseEval)](https://gitlab.cci.drexel.edu/courseeval/team-blue)
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=flat&logo=github&logoColor=white&label=Mirror)](https://github.com/peter201943/student-voice)
### Primary Maintainer ### Primary Maintainer
Peter James Mangelsdorf **Peter James Mangelsdorf**
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=peter201943%238017)](https://discord.com/users/312363766954065930)
[![Outlook](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=peter.j.mangelsdorf)](mailto:peter.j.mangelsdorf@outlook.com) [![Outlook](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=peter.j.mangelsdorf)](mailto:peter.j.mangelsdorf@outlook.com)
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=peter201943%238017)](https://discord.com/)
[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=flat&logo=github&logoColor=white&label=peter201943)](https://github.com/peter201943/) [![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=flat&logo=github&logoColor=white&label=peter201943)](https://github.com/peter201943/)
[![Drexel](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=pjm349@drexel.edu)](mailto:pjm349@drexel.edu)
### Project ### Other Maintainers
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=SE420%2FFA22Q2)](https://discord.gg/QKBxxSS9) **Hoang Nguyen**
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=Mizores%230500)](https://discord.com/users/131543410627575808)
[![Drexel](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=hn374@drexel.edu)](mailto:hn374@drexel.edu)
**Jay Patel**
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=Jay%20Patel%232866)](https://discord.com/users/892071574948184124)
[![Drexel](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=jp3592@drexel.edu)](mailto:jp3592@drexel.edu)
**Charles Porter**
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=scooterjenkins%234332)](https://discord.com/users/555963456445218826)
[![Drexel](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=cap399@drexel.edu)](mailto:cap399@drexel.edu)
**Eric Savoy**
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=Eric%20Savoy%234687)](https://discord.com/users/751931130780975205)
[![Drexel](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=ets43@drexel.edu)](mailto:ets43@drexel.edu)
## Acknowledgements ## Acknowledgements
... ...
......
...@@ -21,6 +21,9 @@ ...@@ -21,6 +21,9 @@
- Already scattered all over the damn place - Already scattered all over the damn place
- Need to merge - how? - Need to merge - how?
- Also bear in mind use of Discord as a "temporary notes platform" - 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 - 7. Required Qualities of Notes
- What do people find useful/necessary? - What do people find useful/necessary?
- Ability to simultaneously edit notes online at same time has been very popular recently - Ability to simultaneously edit notes online at same time has been very popular recently
...@@ -89,6 +92,9 @@ ...@@ -89,6 +92,9 @@
- [(Example) Rust Analyzer's "Architecture"](https://github.com/rust-analyzer/rust-analyzer/blob/master/docs/dev/architecture.md) - [(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) 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) - [(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 ## Change Logs
- Filename: `CHANGELOG.md` - Filename: `CHANGELOG.md`
...@@ -104,6 +110,7 @@ ...@@ -104,6 +110,7 @@
- [(Article) "security-README", proposed standard for open source repos](https://github.com/Trewaters/security-README) - [(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) 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) - [(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 ## Issue Templates
- Filename: `.gitlab/issue_templates/` - Filename: `.gitlab/issue_templates/`
...@@ -173,29 +180,34 @@ ...@@ -173,29 +180,34 @@
- [(Example) GodotEngine Bug Report Issues](https://github.com/godotengine/godot/issues) is intended more for immediate technical-issues - [(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 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) - [(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 ## New Directory Structure
```yaml ```yaml
team-blue/: team-blue/:
.gitlab/issue_templates/: .gitlab/issue_templates/:
code-bug-report.md bug-report.md
code-feature-request.md class-assignment.md
team-bug-report.md documentation.md
team-feature-request.md external-interaction.md
proposal.md
team-process.md
docs/: docs/:
decisions/: decisions/:
0001-use-decisions-as-docs.md
discussions/: discussions/:
architecture.md 2022-02-12.md
changelog.md
conduct.md conduct.md
contributing.md contributing.md
decisions.md
security.md security.md
readme.md
resources/: resources/:
team-logo.png team-logo.png
drexel-logo.png drexel-logo.png
cc-by-logo.png cc-by-logo.png
changelog.md
credits.md
license.md license.md
readme.md readme.md
``` ```
... ...
......
# Alternate Note Locations
- SE420 FA22Q2 Teams OneNote Notebook
- Peter's Google Keep (In Progress Download and Transfer)
- Peter's Personal Notes (In Progress Transfer)
# Notes
[Open this Folder in **Obsidian**](https://obsidian.md/)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment