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

remove discussions directory (now in OneNote); remove references from readme;...

remove discussions directory (now in OneNote); remove references from readme; post notice to documents directory
parent 0e808e67
No related branches found
No related tags found
No related merge requests found
......@@ -25,7 +25,7 @@ A student project to learn FOSS contributing practices.
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 the latest discussion [notes](discussions/) for more detailed information, including proposals.
See the latest discussion (on OneNote, please contact Peter for access) for more detailed information, including proposals.
If you have a security concern, please check the [`SECURITY`](SECURITY.md) for help.
......
## 2022-02-12
## Big Idea
- There are a bunch of decisions that have to be made
- 1. Where to put notes
- 1. Microsoft / Teams / OneNote (WYSIWYG)
2. Gitlab / Wiki (Markdown)
3. Repo / Docs Directory (Markdown)
4. Repo / Obsidian Directory (Modified Markdown)
5. Repo / Code Directory (Markdown) (Place Notes alongside code) (Requires rigor regarding linking/dating of notes)
6. Repo / Docs Directory (ReStructured Text) (More Popular with Python projects, better formatting/structural writing)
- 2. Code of Conduct
- 3. Contributing Guidelines
- Where are the discussions for this?
- 4. Issue Templates
- What formats to use? What do people find useful?
- 5. Which Platform to use (EvaP or Sakai)
- Need to ask Jeff Salvage about difficulty of maintaining adapters
- 6. How to Merge Notes
- Already scattered all over the damn place
- Need to merge - how?
- - SE420 FA22Q2 Teams OneNote Notebook (This will probably continue to see use, especially regarding sensitive information)
- ~~Peter's Google Keep (In Progress Download and Transfer)~~ (No Longer Relevant/Needed)
- ~~Peter's Personal Notes (In Progress Transfer)~~ (No Longer Relevant/Needed)
- Also bear in mind use of Discord as a "temporary notes platform"
- Eh, for now, not of concern
- 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
- Thus promoting the use of in-browser microsoft word
- Also note pattern of only one person taking notes
- 8. Purpose of Repository
- If direct contributions to EvaP/Sakai are intended, how to go about doing so?
- 9. Who are the Notes for
- External/Public? Put in `docs/` directory (and not notes)
- [(Example) Gitlab Docs Folder](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc)
## Using this File and Directory and Editor and Language for Immediate Task Resolution
- File: `2022-02-12.md`
- Directory: `team-blue/notes/`
- Editor: Visual-Studio-Code
- Language: Standard-Markdown
## Immediate Tasks
- [x] [About](#readme) (README) (Needs Fixes)
- [x] [License](#content-license) (LICENSE) (Needs Non-Code (Content) Section)
- [x] [Code of Conduct](#conduct) (CONDUCT)
- [x] [Contributing Guidelines](#code-contributing-guidelines) (CONTRIB)
- [x] [Architecture](#arch-files) (ARCH)
- [x] [Changes](#change-logs) (CHANGELOG)
- [x] [Security](#security) (SECURITY)
- [x] [Issue Templates](#issue-templates) (.gitlab)
- [x] [Issue Tags](#issue-tags)
- [x] [Issue Management](#issue-management) (boards) (milestones) (notifications)
- [ ] [Current Issues](#current-issues) (6) (On Tracker) (Assigned) (Deadlined)
## README
- Filename: `README.md`
- [(Example) Best-README-Template](https://github.com/othneildrew/Best-README-Template) is what Peter likes to use on most projects
- [(Article) Awesome README](https://github.com/matiassingers/awesome-readme) can also be useful
## Content License
- Filename: `LICENSE.md`
- Such as Creative-Commons
- Peter: Using [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) (Almost as permissive as CC0 (Public Domain), just requires attribution)
- [(Resource) Creative Commons Logos](https://creativecommons.org/about/downloads/)
- [(Resource) Creative Commons Markdown](https://github.com/idleberg/Creative-Commons-Markdown)
- [(Discussion) Should I call my license file LICENSE, LICENSE.md, or LICENSE.txt? [closed]](https://opensource.stackexchange.com/questions/10239/should-i-call-my-license-file-license-license-md-or-license-txt)
- [(Discussion) Does it matter what I name my open source license file? [closed]](https://stackoverflow.com/questions/16627477/does-it-matter-what-i-name-my-open-source-license-file)
## Conduct
- Filename: `CONDUCT.md`
- [(Example) Gitlab's Massive Handbook](https://about.gitlab.com/handbook/)
- [(Article) Contributor Covenant](https://www.contributor-covenant.org/)
- [(Article) 18 of the Best Code of Conduct Examples](https://www.i-sight.com/resources/18-of-the-best-code-of-conduct-examples/)
- [(Search) "code-of-conduct-template" on GitHub](https://github.com/topics/code-of-conduct-template)
- [(Article) Awesome Code of Conduct](https://github.com/kgryte/awesome-code-of-conduct)
- [(Article) Your Code of Conduct](https://opensource.guide/code-of-conduct/)
- Peter: From what I can tell, most organizations on GitHub or Gitlab write one or the other:
- Really really basic codes of conduct (just copying the "contributors' covenant")
- Really, really big codes of conduct (which they then host on their own website)
- Peter: I don't like just copying a code of conduct, and I especially dislike dealing with humans, so I am hesitant about just grabbing the contributors' covenant
- Eh, whatever...
## Code Contributing Guidelines
- Filename: `CONTRIB.md`
- What exists?
- What aspects are necessary?
- Google "what are code contributing guidelines"
- [(Example) Contributing to Python](https://github.com/python/cpython/blob/main/.github/CONTRIBUTING.rst)
- [(Example) Gitlab's "Individual contributor license agreement"](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/legal/individual_contributor_license_agreement.md)
- [(Example) Gitlab's "Process.Md"](https://gitlab.com/gitlab-org/gitlab/-/blob/master/PROCESS.md)
- [(Example) Godot Engine's "Contributing.Md"](https://github.com/godotengine/godot/blob/master/CONTRIBUTING.md)
- [(Example) Lightning Network Developers' Code Contribution Guidelines](https://dev.lightning.community/contribute/)
- [(Example) DSpace Software's Code Contribution Guidelines](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines)
- [(Example) Google Tensorflow's Contributing guidelines](https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md)
- [(Example) Microsoft's Mixed Reality Toolkit Coding Guidelines](https://docs.microsoft.com/en-us/windows/mixed-reality/mrtk-unity/contributing/coding-guidelines?view=mrtkunity-2021-05) (Peter's personal favorite)
- [(Example) Atom Editor's Contributing Guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)
## Arch Files
- Filename: `ARCH.md`
- [(Example) Diem's "Implementation Details"](https://github.com/diem/diem/tree/master/consensus#how-is-this-module-organized)
- [(Example) Dependabot's "Architecture"](https://github.com/dependabot/dependabot-core#architecture)
- [(Example) Caddy's "Architecture"](https://caddyserver.com/docs/architecture)
- [(Article)](https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html)
- [(Discussion)](https://news.ycombinator.com/item?id=26048784)
- [(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`
- [(Article) Keep a Changelog](https://keepachangelog.com/en/1.0.0/) is very popular
- "Added", "Fixed", "Changed", "Removed" with bullet-lists linked to issues
- Often used with ["Semantic Versioning 2.0.0"](https://semver.org/) and [ISO 8601 DateTime Strings](https://en.wikipedia.org/wiki/ISO_8601)
- [(Example) Gitlab Changelog](https://gitlab.com/gitlab-org/gitlab/-/blob/master/CHANGELOG.md)
## Security
- Filename: `SECURITY.md`
- [(Article) Add a SECURITY.md file to your Azure Repos](https://snyk.io/blog/add-a-security-md-file-to-your-azure-repos/)
- [(Article) security.txt A proposed standard that allows websites to define security policies.](https://github.com/securitytxt/security-txt)
- [(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/`
- What exists?
- What aspects are necessary?
- Kinds of issues?
- [(Article) A collection of GitHub issue and pull request templates](https://github.com/stevemao/github-issue-templates)
- [(Article) About issue and pull request templates](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)
- [(Article) Step-by-Step Guide to Creating Issue Templates in GitLab](https://eelengneo.medium.com/step-by-step-guide-to-creating-issue-templates-in-gitlab-54627a9a9118)
- [(Article) Gitlab's Description templates](https://docs.gitlab.com/ee/user/project/description_templates.html)
- [(Example) Gitlab's Issue Templates](https://gitlab.com/gitlab-org/gitlab/-/tree/master/.gitlab/issue_templates)
- [(Search) GitHub "pull-request-template"](https://github.com/topics/pull-request-template)
## Issue Tags
- [(Example) GodotEngine Issue Labels](https://github.com/godotengine/godot/labels)
- [(Example) GodotEngine Issue Labels](https://github.com/godotengine/godot-proposals/labels)
- Peter personally likes the use of meta-tags to address missing tags (but only when a platform supports ease of applying these tags - which gitlab does not appear to do)
- [(Discussion) How to automatically set a label on each new issue at creation?](https://forum.gitlab.com/t/how-to-automatically-set-a-label-on-each-new-issue-at-creation/37846)
- Should probably reflect process of an issue
- 1. Unassigned
2. In-Progress
3. Blocked
4. Needs-Reviewing
5. Merged
- 2022-02-13T00:29:00-04:00 Peter:
- Created Three Types of Labels:
- (These are prefixed onto each label)
- `Status`: What stage of completion a task is in
- `Task`: What the task activity is
- `Topic`: What area of work an issue is applicable to
- [Created these labels](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/labels):
- [`Status: BLOCKED` "URGENT - This issue is blocked and in need of assistance" Red](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Status%3A+BLOCKED)
- [`Status: FIXME` "There are errors on this issue - either labels are missing, the task is ambiguous, or the issue has been left stagnant" Pink](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Status%3A+FIXME)
- [`Status: In Progress` "This issue is actively being worked on" Bright-Green](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Status%3A+In+Progress)
- [`Status: In Review` "This issue has been assigned to someone for review" Yellow](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Status%3A+In+Review)
- [`Status: Moved` "This issue has been moved into another issue - see Issue for details" Purple](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Status%3A+Moved)
- [`Status: Resolved` "This issue has been successfully closed" Blue](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Status%3A+Resolved)
- [`Status: Unassigned` "This issue is in need of volunteers" Tan](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Status%3A+Unassigned)
- [`Task: Bug` "Something is incorrect and needs to be replaced or fixed"](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Task%3A+Bug)
- [`Task: Improvement` "Something needs new features, capabilities, or design"](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Task%3A+Improvement)
- [`Task: Proposal` "This issue is proposing some new idea"](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Task%3A+Proposal)
- [`Topic: Class` "Some requirement from the SE420 class"](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Topic%3A+Class)
- [`Topic: Docs` "Written specification for something is needed"](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Topic%3A+Docs)
- [`Topic: External` "Some interaction with a third party is needed - emails, schedules, meetings"](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Topic%3A+External)
- [`Topic: Team` "Organizing, Event Creation, Scheduling, HR, Management"](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/issues?label_name%5B%5D=Topic%3A+Team)
- Created these boards:
- [Development](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/boards/1136):
- Unassigned
- In Progress
- BLOCKED
- In Review
- Resolved
- Moved
- FIXME
## Issue Management
- Milestones
- Boards
- Due Dates
## Current Issues
- What things need to immediately get done/have a physical impact?
## Misc
- Peter: Creating `res/` folder for static objects
- [(Example) NodeJS "Governance.Md"](https://github.com/nodejs/node/blob/master/GOVERNANCE.md)
- [(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/:
bug-report.md
class-assignment.md
documentation.md
external-interaction.md
proposal.md
team-process.md
documents/:
decisions/:
0001-use-decisions-as-docs.md
developers/:
conduct.md # BIG how to be nice
contributing.md # BIG contrib guidelines
decisions.md # EXPLAIN how to make decisions
processes.md # EXPLAIN labels, decision, how the project fits together
discussion-template.md
writing-changelogs.md
discussions/:
2022-02-12.md # a name might follow these as well
public/:
# anything the general public might need to see
security.md # who to really contact
resources/:
team-logo.png
drexel-logo.png
cc-by-logo.png
changelog.md
credits.md
license.md
readme.md
```
## Working Style
- Peter: For *this* repo (the team), branching style will probably be best style to use
- Peter: For the *external project*, an entirely new repo is probably most suitable
## 2022-02-14
## Context
- Started: 2022-02-14T15:00:00-04:00
- Ended: 2022-02-14T15:33:00-04:00
> ## Meeting Agenda
> - I am glad you are all here
> - I do not want to waste anyone's time
> 1. [Review Notes from the Weekend](2022-02-12.md)
> 2. [Where do we Want Notes?](#notes-location)
> 3. [What are our expectations?](#expectations)
> 4. [Do we Understand the Repo?](#understanding-the-repo)
> 5. [What working style do we want to follow? (Branches, Work Days)](#working-style)
> 6. [What Notifications do we want?](#notifications)
> 7. [More Repo Setup](#more-repo-setup)
> 8. [Going Forward](#going-forward)
> ## Notes Location
> - Peter: Have noticed that no-one else is using the OneNote notebook
> - Peter: Would we like to consolidate our notes into the [repo/docs folder](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/tree/main/documents) from now on?
> - Peter: Still intend to keep any "sensitive" notes only in the OneNote notebook and the Teams for any Documents
- Hoang: Please use OneNote
- Jay: Just post the link for today's note in the Discord
- Todo: (Peter) Move *this* note to OneNote
- Todo: (Peter) Move *all* notes to OneNote
> ## Expectations
> - Peter: What do you guys want from this project?
> - Peter: Need way better deadlines
- Peter: Do not want to be waiting till last minute and being only one
- All: Ok with setting deadlines in Outlook
> ## Understanding the Repo
> - Documents/Decisions
> - Documents/Developers/Contributing
> - Documents/Developers/Conduct
- Peter: I am just doing this to meet the professor's requirement
> ## Working Style
> - Peter: How do we want to work on this?
> - Peter: I do not want to be stuck with it
- Peter: (All) please complete the weekly when2meet
- Peter: (All) is everyone ok with working with Git, and specifically branches?
- Eric: I would like some help
- Peter: (Makes Diagram)
- Peter: I am available for peer-coding, please ask (took me 2 years to get comfortable with this)
![](../resources/2022-02-14.git-workflow.png)
> ## Notifications
> - Peter: I added a Discord Bot because I noticed no one received any notifications via email
> - See for Help: [Discord Notifications service | GitLab](https://docs.gitlab.com/ee/user/project/integrations/discord_notifications.html)
> - See for Help: [Discord Notifications · Integrations · Settings · CourseEval / Team Blue · GitLab (drexel.edu)](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/integrations/discord/edit)
- Eric: I did not receive any notifications via email
- All: Is ok with having a discord bot
> ## More Repo Setup
> - Peter: [Created a Fork of EvaP for all CourseEval to use](https://gitlab.cci.drexel.edu/courseeval/EvaP) and [added it as a submodule within our own project](https://gitlab.cci.drexel.edu/courseeval/team-blue/-/commit/0e38f3133f56813beb9c62f9a05340d3f1de9309)
> - See for Help: [How do I work with a git repository within another repository?](https://stackoverflow.com/questions/1811730/how-do-i-work-with-a-git-repository-within-another-repository)
> - See for Help: [! [remote rejected] errors after mirroring a git repository](https://stackoverflow.com/questions/34265266/remote-rejected-errors-after-mirroring-a-git-repository)
> - Peter: [Created branch `docs`]()
- Peter: `dev` and `doc` branches unnecessary, will remove (from team-blue)
- Peter: (Forking model - might need better explanation)
> ## Going Forward
>
> ### Not enough time to spend time investigating and voting
> - Peter: [Played around with Sakai at this URL](https://experimental.nightly.sakaiproject.org/portal/site/99949356-ae19-41c3-9bf8-67a704c47e44/tool/f123b3d2-d816-4531-97db-094e629767e9/add)
> - (Username: `pjm`, Password: `12345`)
> - Peter: See the "Tests & Quizzes" tab for the "Evaluation"
> - Peter: I think the evaluation system only works from inside Sakai (lot of system to support for one feature)
> - Peter: Their form-builder also appears to be lacking
> - Peter: As such, I do not recommend us trying to contribute to it
>
> ### Need Better Issue Templates
> - Peter: I can spend time on this, what would we like on it?
>
> ### Reaching out to the University of Potsdam
> - Peter: I intend to do this, any considerations/objections?
### Meeting Notes
- Peter: I will write an email this evening
- Peter: Please look at the "`simple`" issues on the EvaP project and find ones that interest you
- Peter: Then write them up in the "Issues" on our repository
## Miscellaneous
- Peter: Gitlab has a "milestones" feature that can globally set a deadline for all issues. We should try setting this earlier in the week.
- Peter: Everyone can set their own deadlines in their own issues
- Peter: I am trying **not to assign issues to anyone** so that **each person** can choose **their own issues** and handle **assigning it to themselves**
- Peter: I have been doing this so you can manage yourselves, my apologies if this was ever unclear
# Documents
This folder will eventually host the censored OneNote project notebook and associated documents.
For the time being it will remain empty with this notice.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment