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

rewrite maintainer section of readme to be more inclusive; fix badge images in...

rewrite maintainer section of readme to be more inclusive; fix badge images in readme; restructure documents into proper folder; create first arch decision
parent 55172546
No related branches found
No related tags found
No related merge requests found
[![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/) [![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) [![GitLab](https://img.shields.io/badge/gitlab-%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/)
# [![CourseEval](resources/title.png)](https://gitlab.cci.drexel.edu/courseeval/team-blue) # [![CourseEval](resources/title.png)](https://gitlab.cci.drexel.edu/courseeval/team-blue)
...@@ -59,33 +59,30 @@ Code is distributed under the MIT license. Documentation is distributed under th ...@@ -59,33 +59,30 @@ Code is distributed under the MIT license. Documentation is distributed under th
## Contact ## Contact
### Project ### CourseEval
**CourseEval**
[![Discord](https://img.shields.io/badge/%3CServer%3E-%237289DA.svg?style=flat&logo=discord&logoColor=white&label=SE420%2FFA22Q2)](https://discord.gg/QKBxxSS9) [![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) [![GitLab](https://img.shields.io/badge/gitlab-%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) [![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 ### 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) [![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)
[![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) [![Drexel](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=pjm349@drexel.edu)](mailto:pjm349@drexel.edu)
### Other Maintainers ### Hoang Nguyen
**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) [![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) [![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** ### 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) [![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) [![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** ### 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) [![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) [![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** ### 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) [![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) [![Drexel](https://img.shields.io/badge/Microsoft_Outlook-0078D4?style=flat&logo=microsoft-outlook&logoColor=white&label=ets43@drexel.edu)](mailto:ets43@drexel.edu)
......
# Use Markdown Architectural Decision Records
## Context and Problem Statement
We want to record architectural decisions made in this project.
Which format and structure should these records follow?
## Considered Options
* [MADR](https://adr.github.io/madr/) 2.1.2 – The Markdown Architectural Decision Records
* [Michael Nygard's template](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) – The first incarnation of the term "ADR"
* [Sustainable Architectural Decisions](https://www.infoq.com/articles/sustainable-architectural-design-decisions) – The Y-Statements
* Other templates listed at <https://github.com/joelparkerhenderson/architecture_decision_record>
* Formless – No conventions for file format and structure
## Decision Outcome
Chosen option: "MADR 2.1.2", because
* Implicit assumptions should be made explicit.
Design documentation is important to enable people understanding the decisions later on.
See also [A rational design process: How and why to fake it](https://doi.org/10.1109/TSE.1986.6312940).
* The MADR format is lean and fits our development style.
* The MADR structure is comprehensible and facilitates usage & maintenance.
* The MADR project is vivid.
* Version 2.1.2 is the latest one available when starting to document ADRs.
## Credits
- Shamelessly copied from [Oliver Kopp's Markdown Architectural Decision Records](https://github.com/adr/madr/blob/main/docs/decisions/0000-use-markdown-architectural-decision-records.md)
File moved
File moved
File moved
File moved
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment