From bfed72ea1736530f01cef749dbc33db3d9a31cc2 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Fri, 14 Jul 2023 19:01:39 -0700 Subject: [PATCH 01/13] move to root --- products/statement-generator/CONTRIBUTING.md => CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename products/statement-generator/CONTRIBUTING.md => CONTRIBUTING.md (100%) diff --git a/products/statement-generator/CONTRIBUTING.md b/CONTRIBUTING.md similarity index 100% rename from products/statement-generator/CONTRIBUTING.md rename to CONTRIBUTING.md From 1a83c674efc235448f3bd7f6ea6a58ced76f72eb Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 12:26:53 -0700 Subject: [PATCH 02/13] added H4L getting started link --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b5f30d0..8fa7dad7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,14 +3,14 @@ Thanks for being interested in helping out with Expunge Assist! # Prerequisites -Hopefully by now you have had onboarding and had your github account set up with an ssh key and connected to the HackForLA organization. +This guide assumes you've already been through onboarding through HackforLA. If you haven't, [start here!](https://www.hackforla.org/getting-started) Here are some things you'll want to be familiar with: * command line (cli) * git & github * npm & node -but you're always welcome to ask for help in the `#expunge-assist-frontend` slack channel. +but you're always welcome to ask for help in the `#expunge-assist-dev` slack channel. # Getting Started @@ -36,7 +36,7 @@ We have tasks with things that need to get done located here https://github.com/ ### Development -Expunge-Assist was developed in [TypeScript](https://www.typescriptlang.org/). It's not too much different than JavaScript other than it has type checking. We also have a [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) pacakage for code formatting preferences. If there are anything we don't notice in PRs we'll probably run auto-format on the codebase. +Expunge-Assist was developed in [TypeScript](https://www.typescriptlang.org/). It's not too much different than JavaScript other than it has type checking. We also have a [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) package for code formatting preferences. If there are anything we don't notice in PRs we'll probably run auto-format on the codebase. #### Files * `App.tsx`: This is the entry point for the app which renders different pages based on the route. From 9b4b65c3c9aadd80030e2e9c8fce7fe93ee32fe4 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 12:31:19 -0700 Subject: [PATCH 03/13] small text updates --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fa7dad7..bde51c3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ # Contributing -Thanks for being interested in helping out with Expunge Assist! +Thanks for being interested in helping out with Expunge Assist! 🎉 # Prerequisites @@ -36,7 +36,7 @@ We have tasks with things that need to get done located here https://github.com/ ### Development -Expunge-Assist was developed in [TypeScript](https://www.typescriptlang.org/). It's not too much different than JavaScript other than it has type checking. We also have a [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) package for code formatting preferences. If there are anything we don't notice in PRs we'll probably run auto-format on the codebase. +The Expunge Assist app was developed in [TypeScript](https://www.typescriptlang.org/). It's not too much different than JavaScript other than it has type checking. We also have a [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) package for code formatting preferences. If there are anything we don't notice in PRs we'll probably run auto-format on the codebase. #### Files * `App.tsx`: This is the entry point for the app which renders different pages based on the route. From 7eac1ab36d2f14a17c9f4aac1e817f4831394a04 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 12:35:41 -0700 Subject: [PATCH 04/13] updating intro text --- CONTRIBUTING.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bde51c3c..0017f437 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,16 @@ # Contributing -Thanks for being interested in helping out with Expunge Assist! 🎉 +Thanks for being interested in helping out with Expunge Assist! 🎉 +For any questions, please feel free to ask for help in the `#expunge-assist-dev` slack channel or message the dev lead on slack. # Prerequisites -This guide assumes you've already been through onboarding through HackforLA. If you haven't, [start here!](https://www.hackforla.org/getting-started) +This guide assumes you've already been through onboarding through HackforLA. This onboarding includes getting organization access to Slack, Github, and Google Drive. If you haven't, [start here!](https://www.hackforla.org/getting-started) Here are some things you'll want to be familiar with: * command line (cli) * git & github * npm & node -but you're always welcome to ask for help in the `#expunge-assist-dev` slack channel. - # Getting Started We develop off of the `dev` branch which will contain the latest changes. The `master` branch is left for the production build. From f37d28fefa4fe8ede888917aadd840429d9b5797 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 13:13:19 -0700 Subject: [PATCH 05/13] updating dev section --- CONTRIBUTING.md | 42 +++++++++++++++++++++++++++++++----------- 1 file changed, 31 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0017f437..b00af9eb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,22 +3,31 @@ Thanks for being interested in helping out with Expunge Assist! 🎉 For any questions, please feel free to ask for help in the `#expunge-assist-dev` slack channel or message the dev lead on slack. -# Prerequisites +## Prerequisites This guide assumes you've already been through onboarding through HackforLA. This onboarding includes getting organization access to Slack, Github, and Google Drive. If you haven't, [start here!](https://www.hackforla.org/getting-started) Here are some things you'll want to be familiar with: * command line (cli) * git & github * npm & node +* TypeScript (or JavaScript) -# Getting Started -We develop off of the `dev` branch which will contain the latest changes. The `master` branch is left for the production build. +## Getting Started +Join the following Slack channels: +- #expunge-assist +- #expunge-assist-dev +- #expunge-assist-design-and-content + +### Meetings - (as of July 23, 2023) + +- Dev Meeting: Thursdays 6pm-6:30pm PST +- All Teams Meeting: First Monday of the Month from 5-6pm PST +- Dev/Design/Product Check-in: Mondays 5-5:30pm PST -We have tasks with things that need to get done located here https://github.com/hackforla/expunge-assist/projects/1. Look for `good first issue` label which are simpler tasks. +### Local Setup -### Setup * Clone the repo by running `git clone git@github.com:hackforla/expunge-assist.git` in your command line. * Navigate to the following folder in your cli `/expunge-assist/products/statement-generator/` - Because of how the project was originally set up, this is where the javascript app resides and I am going to refer to this as the __root folder__ from now on. @@ -27,15 +36,26 @@ We have tasks with things that need to get done located here https://github.com/ * You can now make changes and the page should live update! +### Finding an Issue + +The filtered Dev issues are located [here](https://github.com/hackforla/expunge-assist/projects/1?card_filter_query=label%3A%22role%3A+development%22). Issues are organized by role, size, priority, and feature. Please choose from the top couple tasks in the `Prioritized Backlog` column. Look for `good first issue`, `size: 1pt` or `size: small` labels which are simpler tasks. + +Once you find an issue you're interested in, please assign yourself and move it `In Progress (active)`. + +## Development + +The Expunge Assist app was developed in [TypeScript](https://www.typescriptlang.org/). It's not too much different than JavaScript other than it has type checking. We also have a [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) package for code formatting preferences. + +We develop off of the `dev` branch which will contain the latest changes. The `master` branch is left for the production build. + + ### Create a Branch -* Start in the `dev` repo with `git checkout dev` -* Make sure you're up to date with `git pull` -* Create a new branch with `git checkout -b BRANCHNAME` -* You're ready to make changes! +- Start in the `dev` repo with `git checkout dev` +- Make sure you're up to date with `git pull` +- Create a new branch with `git checkout -b BRANCHNAME` -### Development -The Expunge Assist app was developed in [TypeScript](https://www.typescriptlang.org/). It's not too much different than JavaScript other than it has type checking. We also have a [Prettier](https://prettier.io/) and [ESLint](https://eslint.org/) package for code formatting preferences. If there are anything we don't notice in PRs we'll probably run auto-format on the codebase. +Branch names should be descriptive of the task and include the issue number. For example, if you were working on [this issue](https://github.com/hackforla/expunge-assist/issues/698) creating the 'something else' flow in the statement generator, a good branch name would be something like `something-else-689` #### Files * `App.tsx`: This is the entry point for the app which renders different pages based on the route. From 5cc47ee1ff1adb13467398b9647c059f66077f58 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 13:22:52 -0700 Subject: [PATCH 06/13] some cleanup and added reformatter command to PR section --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b00af9eb..8dc3f792 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,11 +67,10 @@ Branch names should be descriptive of the task and include the issue number. For ### Create a Pull Request When you finish making your changes and commit them, you can now make a pull request (PR). +* before pushing, run our reformatter and linter using `npm run lint:fix` * Push your changes to the github repo with `git push origin BRANCHNAME` * Go to the Pull Requests tab on github.com and click "New pull request" * Change so the base branch is `base:dev` * Create a meaningful title and description * Link the PR to the relevant Issue - -Once at least one person approves it, you can squash and merge it into the dev branch! From e28098277c5720e7eb816f2b17f040d4179d79e8 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 13:23:10 -0700 Subject: [PATCH 07/13] adding to the intro section --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8dc3f792..d4d8273b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,9 @@ # Contributing Thanks for being interested in helping out with Expunge Assist! 🎉 -For any questions, please feel free to ask for help in the `#expunge-assist-dev` slack channel or message the dev lead on slack. +This is a developer specific guide. For more general Expunge Assist questions, see our [wiki](https://github.com/hackforla/expunge-assist/wiki) or reach out to `#expunge-assist` on slack. + +For any dev-related questions, please feel free to ask for help in the `#expunge-assist-dev` slack channel or message the [dev lead](https://github.com/hackforla/expunge-assist/wiki/The-Current-Team) on slack. ## Prerequisites This guide assumes you've already been through onboarding through HackforLA. This onboarding includes getting organization access to Slack, Github, and Google Drive. If you haven't, [start here!](https://www.hackforla.org/getting-started) From 1e598a371cd892d1a9e19df1e5f889c8bee16a10 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 13:31:33 -0700 Subject: [PATCH 08/13] update finding an issue section --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d4d8273b..324f382d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,9 +40,11 @@ Join the following Slack channels: ### Finding an Issue -The filtered Dev issues are located [here](https://github.com/hackforla/expunge-assist/projects/1?card_filter_query=label%3A%22role%3A+development%22). Issues are organized by role, size, priority, and feature. Please choose from the top couple tasks in the `Prioritized Backlog` column. Look for `good first issue`, `size: 1pt` or `size: small` labels which are simpler tasks. +The filtered Dev issues are located [here](https://github.com/hackforla/expunge-assist/projects/1?card_filter_query=label%3A%22role%3A+development%22). -Once you find an issue you're interested in, please assign yourself and move it `In Progress (active)`. +See the entire project board [here](https://github.com/hackforla/expunge-assist/projects/1). Issues are organized by role, size, priority, and feature. Please choose from the top couple tasks in the `Prioritized Backlog` column. Look for `good first issue`, `size: 1pt` or `size: small` labels which are simpler tasks. + +Once you find an issue you're interested in, please assign yourself and move it to `In Progress (active)`. ## Development From 643b02aeefb188c686e7d19a271d1d2e845a6fa5 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 13:46:43 -0700 Subject: [PATCH 09/13] add more details to Create a PR section --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 324f382d..852b7d17 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,5 +76,7 @@ When you finish making your changes and commit them, you can now make a pull req * Go to the Pull Requests tab on github.com and click "New pull request" * Change so the base branch is `base:dev` * Create a meaningful title and description -* Link the PR to the relevant Issue +* Link the PR to the relevant issue +* Move issue to `Ready for Review` section and post in `#expunge-assist-dev` with a link to the PR +* Once you have 1 approval, assign to the dev lead to have issue merged. From 004033d490518528a2018a941a7bdc6e077b44b9 Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 14:03:30 -0700 Subject: [PATCH 10/13] add a reviewing PR section --- CONTRIBUTING.md | 35 ++++++++++++++++++++++++++--------- 1 file changed, 26 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 852b7d17..1c2e2ca7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,5 @@ # Contributing + Thanks for being interested in helping out with Expunge Assist! 🎉 This is a developer specific guide. For more general Expunge Assist questions, see our [wiki](https://github.com/hackforla/expunge-assist/wiki) or reach out to `#expunge-assist` on slack. @@ -6,8 +7,11 @@ This is a developer specific guide. For more general Expunge Assist questions, s For any dev-related questions, please feel free to ask for help in the `#expunge-assist-dev` slack channel or message the [dev lead](https://github.com/hackforla/expunge-assist/wiki/The-Current-Team) on slack. ## Prerequisites + This guide assumes you've already been through onboarding through HackforLA. This onboarding includes getting organization access to Slack, Github, and Google Drive. If you haven't, [start here!](https://www.hackforla.org/getting-started) +Otherwise, please take a look through our [wiki](https://github.com/hackforla/expunge-assist/wiki) to get familiar with the project, our team, and processes. + Here are some things you'll want to be familiar with: * command line (cli) * git & github @@ -16,6 +20,7 @@ Here are some things you'll want to be familiar with: ## Getting Started + Join the following Slack channels: - #expunge-assist - #expunge-assist-dev @@ -53,23 +58,19 @@ The Expunge Assist app was developed in [TypeScript](https://www.typescriptlang. We develop off of the `dev` branch which will contain the latest changes. The `master` branch is left for the production build. -### Create a Branch +### Working on an Issue + +Once you've claimed an issue for your own, you're welcome to get started on it. - Start in the `dev` repo with `git checkout dev` - Make sure you're up to date with `git pull` - Create a new branch with `git checkout -b BRANCHNAME` +- Make your changes Branch names should be descriptive of the task and include the issue number. For example, if you were working on [this issue](https://github.com/hackforla/expunge-assist/issues/698) creating the 'something else' flow in the statement generator, a good branch name would be something like `something-else-689` -#### Files -* `App.tsx`: This is the entry point for the app which renders different pages based on the route. - * `PageContainer.tsx` -> `Form.tsx`: This is where different pages and steps of the Form gets rendered. - -* `RoutingContext.tsx`: We use React Context to handle giving each page component the state and functions relating to navigating. -* `FormStateContext.tsx`: This handles tracking the current state of the filled out form. - - ### Create a Pull Request + When you finish making your changes and commit them, you can now make a pull request (PR). * before pushing, run our reformatter and linter using `npm run lint:fix` * Push your changes to the github repo with `git push origin BRANCHNAME` @@ -80,3 +81,19 @@ When you finish making your changes and commit them, you can now make a pull req * Move issue to `Ready for Review` section and post in `#expunge-assist-dev` with a link to the PR * Once you have 1 approval, assign to the dev lead to have issue merged. +### Reviewing a Pull Request + +Pull Requests that are ready for review can be found two places: the `#expunge-assist-dev` channel on slack and linked in issues in the `Ready to Review` column on the project board. + +Assign to yourself. + +Using the branch listed in the PR, run the app locally. Ask yourself these questions: +1. Does it solve the issue listed? +2. Are there unnecessary comments or console logs? +3. Is it responsive? + +Bonus points for evaluating the rest of the page for any bugs or design mistakes. If you find any unrelated to the PR you're reviewing, please [write a new issue](https://github.com/hackforla/expunge-assist/issues/new?assignees=&labels=&projects=&template=blank-issue.md&title=). + +If the PR needs updates, leave specific comments on the PR for the developer to address. Reassign to the developer. + +If the PR passes the questions above, approve it and assign to the dev lead to be merged! \ No newline at end of file From 95719171597f9f767a153f605a93f1e7febdd07a Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 14:04:41 -0700 Subject: [PATCH 11/13] udpate ; --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c2e2ca7..572ae99d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -89,8 +89,7 @@ Assign to yourself. Using the branch listed in the PR, run the app locally. Ask yourself these questions: 1. Does it solve the issue listed? -2. Are there unnecessary comments or console logs? -3. Is it responsive? +2. Could it be refactored? Bonus points for evaluating the rest of the page for any bugs or design mistakes. If you find any unrelated to the PR you're reviewing, please [write a new issue](https://github.com/hackforla/expunge-assist/issues/new?assignees=&labels=&projects=&template=blank-issue.md&title=). From e6b6e221560b8b5fb263dec66d6d723c77ecc3ca Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 14:08:28 -0700 Subject: [PATCH 12/13] update naming convention --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 572ae99d..70010493 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,7 +67,7 @@ Once you've claimed an issue for your own, you're welcome to get started on it. - Create a new branch with `git checkout -b BRANCHNAME` - Make your changes -Branch names should be descriptive of the task and include the issue number. For example, if you were working on [this issue](https://github.com/hackforla/expunge-assist/issues/698) creating the 'something else' flow in the statement generator, a good branch name would be something like `something-else-689` +Branch names should be descriptive of the task and include the issue number. For example, if you were working on [this issue](https://github.com/hackforla/expunge-assist/issues/698) creating the 'something else' flow in the statement generator, a good branch name would be something like `689-something-else`. Make sure not to use a `#` sign to start your branch name as git hates them. ### Create a Pull Request From 0f2964e4abd0d281c7d3bf00781b69557bb2894e Mon Sep 17 00:00:00 2001 From: Sydney Walcoff Date: Sun, 23 Jul 2023 14:14:31 -0700 Subject: [PATCH 13/13] small updates to PR process --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70010493..f0fe7c14 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,7 +85,7 @@ When you finish making your changes and commit them, you can now make a pull req Pull Requests that are ready for review can be found two places: the `#expunge-assist-dev` channel on slack and linked in issues in the `Ready to Review` column on the project board. -Assign to yourself. +Assign yourself as a reviewer on the PR. Using the branch listed in the PR, run the app locally. Ask yourself these questions: 1. Does it solve the issue listed? @@ -93,6 +93,6 @@ Using the branch listed in the PR, run the app locally. Ask yourself these quest Bonus points for evaluating the rest of the page for any bugs or design mistakes. If you find any unrelated to the PR you're reviewing, please [write a new issue](https://github.com/hackforla/expunge-assist/issues/new?assignees=&labels=&projects=&template=blank-issue.md&title=). -If the PR needs updates, leave specific comments on the PR for the developer to address. Reassign to the developer. +If the PR needs updates, leave specific comments on the PR for the developer to address. Tag the developer and update status to `request changes`. If the PR passes the questions above, approve it and assign to the dev lead to be merged! \ No newline at end of file