diff --git a/notes/2022-02-12.md b/notes/2022-02-12.md index 29e9f4a99e19684f104ac28390c8f0091c4e364b..073b1f4ac64ad6f12c534f46b10f2b23b9456f76 100644 --- a/notes/2022-02-12.md +++ b/notes/2022-02-12.md @@ -47,15 +47,17 @@ - [ ] [Changes](#change-logs) (CHANGELOG) - [ ] [Security](#security) (SECURITY) - [ ] [Issue Templates](#issue-templates) (.gitlab) -- [ ] [Issue Tags](#issue-tags) +- [x] [Issue Tags](#issue-tags) - [ ] [Issue Management](#issue-management) (boards) (milestones) (notifications) -- [ ] [Issues](#issues) (6) (On Tracker) (Assigned) (Deadlined) +- [ ] [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/) @@ -64,37 +66,47 @@ - [(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/) ## 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) ## 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) ## 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) NodeJS Security Details via Dedicated Tab (GitHub)](https://github.com/nodejs/node/security) - [(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) ## Issue Templates +- Filename: `.gitlab/issue_templates/` - What exists? - What aspects are necessary? - Kinds of issues? @@ -103,20 +115,88 @@ - [(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 -## Issues +## 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) + +## 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 + docs/: + decisions/: + discussions/: + architecture.md + changelog.md + conduct.md + contributing.md + decisions.md + security.md + readme.md + resources/: + team-logo.png + drexel-logo.png + cc-by-logo.png + license.md + readme.md +```