From 21acc1891a8c383d691a16219fb1693d7b25de1d Mon Sep 17 00:00:00 2001 From: Mekesia Brown Date: Wed, 28 Jun 2023 11:54:58 -0400 Subject: [PATCH 1/5] docs: add write up on project, as of June 2023 --- WRITEUP.md | 127 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 WRITEUP.md diff --git a/WRITEUP.md b/WRITEUP.md new file mode 100644 index 0000000..e9ad1a8 --- /dev/null +++ b/WRITEUP.md @@ -0,0 +1,127 @@ +# Please contribute! Reword, delete, add, anything + +## Team Communication +Weekly development check-ins are held on Tuesdays at 8 pm EST. The team uses Google Meet, which is more cost-effective (free). The team also uses Slack for daily communication. For all documents the team relies on the [qg-docs GitHub repository](https://github.com/QueerGlobal/qg-docs) unless individual Google Docs files are utilized. All sources are pinned to the relative Slack channel. + +### Communication Between Engineers - The Communication "Culture" +Once topic-specific channels were created the conversations became free-flowing. + +The #development channel is the hub where all ideas reach everyone the fastest. + +For all frontend-oriented work there are the QG GitHub account's [issues](https://github.com/QueerGlobal/qg-frontend-v2/issues) and [pull requests](https://github.com/QueerGlobal/qg-frontend-v2/pulls) opportunities to discuss code-specific details. + +Note: Initially there were no standards in place for things like how to write pull request comments, code formatting and style, and how to distribute work to new team members, regardless of their experience level. We all had to work together through situations usually laid out ahead of time by management for an established entity. We became our own AND each other’s “Manager”. The end result is our current culture: Where own standards for how to work together are accepted while at the same time being courageously open to and ready for inevitable needed changes. There is an acceptance of our autonomy through trust. + +### Communication with Volunteers +Deacon is the QG Co-Founder and is ever-present to greet one and all. In all Slack channels, Deacon is the one who will direct volunteers to the QG family. + +Once team members join the QG Slack, and Deacon announces them, they have access to the full family and is welcome to take initiative in introducing themselves in 1:1 conversations and in the general Slack channels. + +Our project relies on individuals who tend to be self-starters; those who are comfortable with taking initiative on the Roadmap tickets as well as seeing the valuable app areas in need of building out first compared to other areas. This is a good thing because it means that the team is not bogged down with the need to micromanage. + +## Product-Oriented Process +### The “Defined Problem” +Need for a new, modern, web application with immediate resources for networking with professionals, knowing the latest events, and building community for LGBTQIAA+ people, by LGBTQIAA+ people. + +### The “Solution” +Create a web application that serves as this source/product. A web application, vs a website, because it will be interactive and have a database that stores relevant resource data. + +### Methodology +Agile? Scrum? Waterfall? TBD + +A series of Roadmap boards are used for task distribution, broken up into “tickets”: +[Frontend Roadmap](https://github.com/orgs/QueerGlobal/projects/1) +[Infrastructure Roadmap](https://github.com/orgs/QueerGlobal/projects/3) +[QueerGlobal Development Onboarding Documentation](https://github.com/orgs/QueerGlobal/projects/2/views/1) + +### Targeting User Needs +From surveys and informational interviews? + +From UX interviews? + +Research? + + +### Design +A traditional web application structure of main pages as well as unique features such as sharing artworks. + +### Model +Wireframes, mockups, prototypes, etc. TBD + +### Application Architecture Overview +List of minimum requirements for local development +- Node JS version 18.9.1 +- NPM version TBD +- MySQL version TBD +- Etc. TBD + +Create-React-App, Node JS?, ESLint, MySQL?. +Handling stale API data? +Pull request reviews consist of engineers across the team zeroing in on all aspects of each other's code. + +MySQL +React +Create-React-App boilerplate +Dedicated GH repo for client front-end app +Dedicated GH repo for microservices + +Logging - Management Tool +Client (FE): TBD +Database: TBD +Server (BE): TBD +API rates, stagnant data, observation? +Network: TBD + +Version Control - Git; Repositories housed on GitHub +As of June of 2023, every engineer can access, review, approve, and/or block a pull request + +Pull request template and labels created by team and are currently being formalized + +### Testing +A demo-repository is being planned for a staging version of the app. + +Unit, automated, QA, user, performance - TBD + +To be used: [Accessibility Conformance Report, 2018](https://www.fdic.gov/about/doing-business/acquisition/acr.pdf) - Information Technology Industry Council + +### Documentation +A GitHub repository of documents, future Wiki, TBD. + +Will cover requirements for product functionality, what went into the designs, architecture decision making, testing, group process, etc. + +Changelog? TBD + +### Deployment +AWS? + +Other cloud environment? + +A/B testing? SEO? TBD + +### Measurements/analysis +Quality metrics, API connection rates, user feedback, TBD. Analytics is critical for the effectiveness of the product. + +Example of measurement performance, from the open-source tool [Lighthouse Chrome DevTools report on performance metrics](https://developers.google.com/web/tools/lighthouse#devtools) +- Install Chrome +- Open Chrome DevTools +- Select the Lighthouse panel +- Hit "Generate report" + + +Lighthouse Node module - For local report generation +For testing web pages in production + +### Maintenance +Bugs; TBD + +### Educating the user +FAQs, video tuts, video interviews, TBD + + +## Mobile Development +Probably not but TBD + + +## Marketing and Promotion +TBD + From 5e326dbc762114179907c3127e697d659cccd1b1 Mon Sep 17 00:00:00 2001 From: Mekesia Brown Date: Wed, 28 Jun 2023 12:38:29 -0400 Subject: [PATCH 2/5] docs: note Node version as LTS --- WRITEUP.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/WRITEUP.md b/WRITEUP.md index e9ad1a8..1511aaf 100644 --- a/WRITEUP.md +++ b/WRITEUP.md @@ -50,7 +50,7 @@ Wireframes, mockups, prototypes, etc. TBD ### Application Architecture Overview List of minimum requirements for local development -- Node JS version 18.9.1 +- Node JS LTS (as of June 2023) version - NPM version TBD - MySQL version TBD - Etc. TBD From 80fa16bcde2914a2ac27670997c61bbf7244e520 Mon Sep 17 00:00:00 2001 From: Mekesia Brown Date: Fri, 30 Jun 2023 04:08:21 -0400 Subject: [PATCH 3/5] docs: add details and reword some parts --- WRITEUP.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/WRITEUP.md b/WRITEUP.md index 1511aaf..5ea9d29 100644 --- a/WRITEUP.md +++ b/WRITEUP.md @@ -50,6 +50,7 @@ Wireframes, mockups, prototypes, etc. TBD ### Application Architecture Overview List of minimum requirements for local development +- Golang TBD - Node JS LTS (as of June 2023) version - NPM version TBD - MySQL version TBD @@ -59,9 +60,10 @@ Create-React-App, Node JS?, ESLint, MySQL?. Handling stale API data? Pull request reviews consist of engineers across the team zeroing in on all aspects of each other's code. -MySQL -React -Create-React-App boilerplate +[Golang](https://go.dev/) +[MySQL](https://dev.mysql.com/) +[React](https://reactjs.org/) +[Create-React-App boilerplate](https://create-react-app.dev/) Dedicated GH repo for client front-end app Dedicated GH repo for microservices @@ -84,6 +86,8 @@ Unit, automated, QA, user, performance - TBD To be used: [Accessibility Conformance Report, 2018](https://www.fdic.gov/about/doing-business/acquisition/acr.pdf) - Information Technology Industry Council +Testing risks? Taking more than expected time? What do do with faulty tests; TBD + ### Documentation A GitHub repository of documents, future Wiki, TBD. @@ -112,7 +116,7 @@ Lighthouse Node module - For local report generation For testing web pages in production ### Maintenance -Bugs; TBD +Bug-tracking procedures; TBD ### Educating the user FAQs, video tuts, video interviews, TBD From bf5cc3b7344cbecbd6335cfbe237830fba85d21e Mon Sep 17 00:00:00 2001 From: Mekesia Brown Date: Fri, 30 Jun 2023 05:24:41 -0400 Subject: [PATCH 4/5] docs: update w/ links, some rewording; add references --- WRITEUP.md | 26 ++++++++++++++++++-------- 1 file changed, 18 insertions(+), 8 deletions(-) diff --git a/WRITEUP.md b/WRITEUP.md index 5ea9d29..ceb4f59 100644 --- a/WRITEUP.md +++ b/WRITEUP.md @@ -12,7 +12,7 @@ For all frontend-oriented work there are the QG GitHub account's [issues](https: Note: Initially there were no standards in place for things like how to write pull request comments, code formatting and style, and how to distribute work to new team members, regardless of their experience level. We all had to work together through situations usually laid out ahead of time by management for an established entity. We became our own AND each other’s “Manager”. The end result is our current culture: Where own standards for how to work together are accepted while at the same time being courageously open to and ready for inevitable needed changes. There is an acceptance of our autonomy through trust. -### Communication with Volunteers +### Communication with Interested/New Volunteers Deacon is the QG Co-Founder and is ever-present to greet one and all. In all Slack channels, Deacon is the one who will direct volunteers to the QG family. Once team members join the QG Slack, and Deacon announces them, they have access to the full family and is welcome to take initiative in introducing themselves in 1:1 conversations and in the general Slack channels. @@ -41,7 +41,6 @@ From UX interviews? Research? - ### Design A traditional web application structure of main pages as well as unique features such as sharing artworks. @@ -65,7 +64,7 @@ Pull request reviews consist of engineers across the team zeroing in on all aspe [React](https://reactjs.org/) [Create-React-App boilerplate](https://create-react-app.dev/) Dedicated GH repo for client front-end app -Dedicated GH repo for microservices +Dedicated GH repos for microservices Logging - Management Tool Client (FE): TBD @@ -75,12 +74,13 @@ API rates, stagnant data, observation? Network: TBD Version Control - Git; Repositories housed on GitHub + As of June of 2023, every engineer can access, review, approve, and/or block a pull request -Pull request template and labels created by team and are currently being formalized +Pull request template and labels created by team and are currently being formalized [in this document](https://docs.google.com/document/d/1prQ08FbkMTHAMC2-BvpEeLSk3_YoRl18owza9_t3xJY/edit?pli=1) ### Testing -A demo-repository is being planned for a staging version of the app. +A demo-repository is being planned for a staging version of the app. Here is [a spreadsheet of details](https://docs.google.com/spreadsheets/d/1xlDfIMQn_NXb4PbE8QkncdGxw6H-h9RGGHn8_45z5r4/edit#gid=584784234) for future group testing Unit, automated, QA, user, performance - TBD @@ -88,6 +88,8 @@ To be used: [Accessibility Conformance Report, 2018](https://www.fdic.gov/about/ Testing risks? Taking more than expected time? What do do with faulty tests; TBD +If signup, login, and/or payments tests are not working, this is a level 1 severity. Take the site down immediately. + ### Documentation A GitHub repository of documents, future Wiki, TBD. @@ -95,6 +97,8 @@ Will cover requirements for product functionality, what went into the designs, a Changelog? TBD +Database relations broken down in [this document](https://docs.google.com/document/d/1rt0V8w4bygqfRPnhwbbE9FCcKIAJI2yT1as8AMG_ehA/edit#heading=h.yfunt0g4gpy6) + ### Deployment AWS? @@ -102,6 +106,8 @@ Other cloud environment? A/B testing? SEO? TBD +If signup, login, and/or payments are not working, then the app is not working. Take the site down immediately. + ### Measurements/analysis Quality metrics, API connection rates, user feedback, TBD. Analytics is critical for the effectiveness of the product. @@ -111,21 +117,25 @@ Example of measurement performance, from the open-source tool [Lighthouse Chrome - Select the Lighthouse panel - Hit "Generate report" - Lighthouse Node module - For local report generation + For testing web pages in production +If signup, login, and/or payments are not working, then the app is not working. Take the site down immediately. + ### Maintenance Bug-tracking procedures; TBD +If signup, login, and/or payments are not working, then the app is not working. Take the site down immediately. + ### Educating the user FAQs, video tuts, video interviews, TBD - ## Mobile Development Probably not but TBD - ## Marketing and Promotion TBD +References: +[IEEE 829 Test Plan Example, Ecommerce Website Cross Browser Testing Test Plan](https://docs.google.com/document/d/1F1TUX5BkviRbw8auI2Xq2K2wyGTS-Ag14DRymiELmzc/edit) \ No newline at end of file From b56ff027504d8bdd9ae70f34802e250d113514ba Mon Sep 17 00:00:00 2001 From: Mekesia Brown Date: Mon, 3 Jul 2023 18:10:38 -0400 Subject: [PATCH 5/5] docs: add recommended tools --- WRITEUP.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/WRITEUP.md b/WRITEUP.md index ceb4f59..4a1f40a 100644 --- a/WRITEUP.md +++ b/WRITEUP.md @@ -53,9 +53,12 @@ List of minimum requirements for local development - Node JS LTS (as of June 2023) version - NPM version TBD - MySQL version TBD +- ESLint Extension +- Golang CI/CS Lint +- Precommit, a language-specific commit checker - Etc. TBD -Create-React-App, Node JS?, ESLint, MySQL?. +Create-React-App, Node JS?, MySQL?. Handling stale API data? Pull request reviews consist of engineers across the team zeroing in on all aspects of each other's code.