From 3c11a6d85c35852e8895ac7d620d91569f17ba25 Mon Sep 17 00:00:00 2001 From: Vanessa Rodriguez <124115753+vraer@users.noreply.github.com> Date: Mon, 16 Oct 2023 22:44:17 -0700 Subject: [PATCH 1/2] Update formatting and issue progression section --- .../dev/about-the-website-development-team.md | 70 +++++++++++++++++++ .../about-the-website-development-team.md | 31 -------- 2 files changed, 70 insertions(+), 31 deletions(-) create mode 100644 docs/roles/dev/about-the-website-development-team.md delete mode 100644 docs/roles/dev/pending-audit/about-the-website-development-team.md diff --git a/docs/roles/dev/about-the-website-development-team.md b/docs/roles/dev/about-the-website-development-team.md new file mode 100644 index 00000000..99709aaf --- /dev/null +++ b/docs/roles/dev/about-the-website-development-team.md @@ -0,0 +1,70 @@ +# About the Website Development Team + +## Team Levels + +The Hack for LA Website Development Team is a **Level 1 Team**. This means we have a support system to help all new developers learn the basics. When you join, you'll start at Level 1 and go through a learning process. The goal is to get you familiar with how we do things. Once you've learned enough and are doing well, you can move on to a Level 2 team for more advanced work. + +## Technologies Used + +Our tech stack consists of both front-end and back-end technologies: + +- **Front-end**: Our front-end is built using the following languages and libraries: + - HTML + - SCSS + - JavaScript + +- **Back-end and DevOps**: For back-end and development operations, we rely on: + - GitHub Actions + - Google Apps Script + +## Developer Expectations + +When you join the Hack for LA Website Development Team, there are certain expectations: + +### Time Commitment + +- **Weekly Hours**: A minimum of 6 hours per week is required, not including vacations or weeks off. + +### Communication + +- **Announcements**: If you plan to take a week off or go on a longer vacation, notify the tech leadership team. This can be done through a Slack message in the `hfla-site` channel and an @ mention in the comment section of the issue you're working on. + +### Meetings + +- **Mandatory**: Attend at least one of the following meetings each week: + - All team weekly meeting (UX/UR, Development, Product) — Sundays 10am-12 noon Pacific Time. + - Developer (front-end/back-end) weekly team meeting — Tuesdays 7-8 pm Pacific Time. +- **Optional**: Developer Office Hours meeting — Thursdays 7-8 pm Pacific Time. + +### Issue Handling + +- Work on one issue at a time. +- Wait until your pull request is merged before working on another issue. + +### Skill Progression + +Start with issues of increasing complexity in the following order: + +```mermaid +graph LR + +A(Good first issue #1) +B(Good first issue #2) +C(Small) +D(Medium) +E(Large) + + A --> B + B --> C + C --> D + D --> E + + style A fill:#7057FF33,stroke:#7057ff; + style B fill:#7057FF33,stroke:#7057ff; + style C fill:#C5DEF533,stroke:#c5def5; + style D fill:#1C79AF33,stroke:#1c79af; + style E fill:#0717FC33,stroke:#0717fc; + +``` + +!!! note "Exceptions to these expectations can be discussed with the tech leadership team on a case-by-case basis." diff --git a/docs/roles/dev/pending-audit/about-the-website-development-team.md b/docs/roles/dev/pending-audit/about-the-website-development-team.md deleted file mode 100644 index e0a4117a..00000000 --- a/docs/roles/dev/pending-audit/about-the-website-development-team.md +++ /dev/null @@ -1,31 +0,0 @@ -- The Hack for LA Website Development Team is a level 1 team, which means the team has a support structure in place for all developers on the team to learn best practices before moving on to a level 2 team. In addition, this means all developers new to the team go through the same process. - -- Our front end is HTML, SCSS, and JavaScript. Our back end and development operations use GitHub Actions and Google Apps Script. - -**Once you join our team, we expect all developers to do the following:** -- Require a time commitment of at least 6 hours per week, excluding vacations and weeks off. - - Also, please let the tech leadership team know (through a Slack message in the hfla-site channel as well as an @ mention in a comment of the issue that you would be working on) if you are planning to take a week off or a longer vacation. -- Attend at least one of the following meetings each week: - - All team weekly meeting (UX/UR, Development, Product), Sundays 10am-12 noon Pacific Time - - Developer (front-end/back-end) weekly team meeting, Tuesdays 7-8 pm Pacific Time - - (Optional) Developer Office Hours meeting, Thursdays 7-8pm Pacific Time - - In case, you are unable in any given week, you should reach out to the tech leadership team. Exceptions to this requirement may be provided on a case-by-case basis. -- Complete a pre-work developer checklist issue, which we will guide you through. -- Review pull requests, which we will teach you how to do. -- Work on one issue at a time and wait until your pull request is merged before working on another issue. -- Progress through issues with increasing complexity in the following order: - - Good first issue - - Good second issue - - Small - - Medium - - Large - - The reasons for this progression are: - - The issues start out as being prescriptive and become less so as you gain more experience by working through increasingly complex issues. - - We are trying to teach you the team methodology through the issues themselves. - - It ensures you understand what we expect and the quality of contributions. - -- Also, please only do one good first issue, one good second issue, and one small issue. - - This will ensure we have enough good first, good second, and small issues for newer developers to work on. - - Exceptions may be made for working on more than one small issue during the entirety of your time on the website team but please speak with a team lead with your reason for doing so, such as a medium issue being too difficult for you and you need to learn something new by doing a small issue as a stepping stone to help you progress to a medium issue. From d76f971335d1893efc03dcd49450fe7a4aa6a349 Mon Sep 17 00:00:00 2001 From: Vanessa Rodriguez <124115753+vraer@users.noreply.github.com> Date: Fri, 27 Oct 2023 15:34:51 -0700 Subject: [PATCH 2/2] Update about-the-website-development-team.md - Remove 'Optional' from developer office hours meeting - Change 'Announcements' to 'Time Off' --- docs/roles/dev/about-the-website-development-team.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/roles/dev/about-the-website-development-team.md b/docs/roles/dev/about-the-website-development-team.md index 99709aaf..440a5b75 100644 --- a/docs/roles/dev/about-the-website-development-team.md +++ b/docs/roles/dev/about-the-website-development-team.md @@ -27,14 +27,14 @@ When you join the Hack for LA Website Development Team, there are certain expect ### Communication -- **Announcements**: If you plan to take a week off or go on a longer vacation, notify the tech leadership team. This can be done through a Slack message in the `hfla-site` channel and an @ mention in the comment section of the issue you're working on. +- **Time Off**: If you plan to take a week off or go on a longer vacation, notify the tech leadership team. This can be done through a Slack message in the `hfla-site` channel and an @ mention in the comment section of the issue you're working on. ### Meetings - **Mandatory**: Attend at least one of the following meetings each week: - All team weekly meeting (UX/UR, Development, Product) — Sundays 10am-12 noon Pacific Time. - Developer (front-end/back-end) weekly team meeting — Tuesdays 7-8 pm Pacific Time. -- **Optional**: Developer Office Hours meeting — Thursdays 7-8 pm Pacific Time. + - Developer Office Hours meeting — Thursdays 7-8 pm Pacific Time. ### Issue Handling