hackforla / hackforla/tdm-calculator
Product: Create a WIKI page for developer workflow
- Dominant language
- JavaScript
- Stars
- 68
- Forks
- 47
- Avg merge
- 3d 9h
- Merged PRs (30d)
- 25
Description
### Overview
We need to create a WIKI page that outlines the developer workflow so that they can complete tasks effectively.
#### Details
Bonnie sent this message to two developers:
> I am not sure why the pr was accepted without a before an after image, but at the least it should have caught in the review process. It seems like we have stopped doing the peer review process on PRs, lets bring that back now that we have enough devs. Peer review should consist of a different dev than the person putting in the PR, to get the pr's code on to their computer and then review the pr to see if it matches what was asked for in the issue. If it does not, the reviewer leaves notes on the PR letting the PR author know what criteria was not met, or any other problems they observed. The reviewer does not fix the code, the PR author does. Then once the fix has been applied, the PR author re-requests a review from the reviewer, and if it passes, they indicate it is ready to be merged. Then someone with merge authority checks it again (this should be fast, because there should be no problems to document), and then it is merged.
### Action Items
- [ ] Break down bonnie's comment into an outline of what developers should do.
- [x] Revise the text on 1.01 in a comment to include Reviewing a PR and the issues from comment comment
- [ ] Get signoff by product
- [ ] update wiki page
- [ ] Review 1.02 and write a draft revision to the workflow for Developer and Lead Developerto include PR reviews in a comment below
- [ ] Get signoff by product
- [ ] update wiki page
- [ ] Review with product and dev. Update if needed based on feedback
- [ ] Once finalized, add before and after images to the slide in the staging deck for this issue (see link under resources)
- [ ] Get Stakeholder sign-off via the stakeholder meeting slide deck.
### Resources/Instructions
- 1.01 https://github.com/hackforla/tdm-calculator/wiki/Contributing-Code
- 1.02 https://github.com/hackforla/tdm-calculator/wiki/Issue-Workflow
- Shared Working Doc - [Contributing Code - DRAFT](https://docs.google.com/document/d/12C6QClg5g4njsx63o1gNcSQqwth15CoKpLvXuLaO2mk/edit?usp=sharing)
#### Staging and Release decks
- [Staging Deck](https://docs.google.com/presentation/d/1crZ3IxqA4hAu3qzD7ns93Ieuqjwh6wyEtuX_46cP-fg/)
- [Staging slide, ISSUE NUMBER]
- Release Deck
- [2025-MM-DD Release deck, slide ISSUE NUMBER]
Contributor guide
Assessment
This issue has not been assessed yet.