diff --git a/README.md b/README.md index 9132521fb6ab3eb1953fd669ae7405b3f9c06955..cf7fb9548188aba38de08c24222845bf5cc926ad 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [](https://opensource.org/licenses/MIT) [](https://creativecommons.org/licenses/by/4.0/) -[](https://gitlab.cci.drexel.edu/courseeval/team-blue) +[](https://gitlab.cci.drexel.edu/courseeval/team-blue) [ cs.drexel.edu](https://www.cs.drexel.edu/) # [](https://gitlab.cci.drexel.edu/courseeval/team-blue) @@ -59,33 +59,30 @@ Code is distributed under the MIT license. Documentation is distributed under th ## Contact -### Project -**CourseEval** +### CourseEval [](https://discord.gg/QKBxxSS9) -[](https://gitlab.cci.drexel.edu/courseeval/team-blue) +[](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://github.com/peter201943/) [](mailto:pjm349@drexel.edu) -### Other Maintainers -**Hoang Nguyen** +### Hoang Nguyen [](https://discord.com/users/131543410627575808) [](mailto:hn374@drexel.edu) -**Jay Patel** +### Jay Patel [](https://discord.com/users/892071574948184124) [](mailto:jp3592@drexel.edu) -**Charles Porter** +### Charles Porter [](https://discord.com/users/555963456445218826) [](mailto:cap399@drexel.edu) -**Eric Savoy** +### Eric Savoy [](https://discord.com/users/751931130780975205) [](mailto:ets43@drexel.edu) diff --git a/documents/decisions/0001-use-decisions.md b/documents/decisions/0001-use-decisions.md new file mode 100644 index 0000000000000000000000000000000000000000..8f7eab5947e639fff36b7af2e81e16a481532ff7 --- /dev/null +++ b/documents/decisions/0001-use-decisions.md @@ -0,0 +1,30 @@ + +# 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) diff --git a/CONDUCT.md b/documents/developers/CONDUCT.md similarity index 100% rename from CONDUCT.md rename to documents/developers/CONDUCT.md diff --git a/CONTRIBUTING.md b/documents/developers/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to documents/developers/CONTRIBUTING.md diff --git a/notes/2022-02-12.md b/documents/discussions/2022-02-12.md similarity index 100% rename from notes/2022-02-12.md rename to documents/discussions/2022-02-12.md diff --git a/SECURITY.md b/documents/public/SECURITY.md similarity index 100% rename from SECURITY.md rename to documents/public/SECURITY.md