hackforla / hackforla/website

Create a wiki page for details on new PR columns

Open
#3,227 2 comments 0 reactions 0 assignees View on GitHub
Complexity: Large Dependency Feature: Wiki role: back end/devOps size: 2pt
Dominant language
JavaScript
Stars
363
Forks
872
Avg merge
2d 21h
Merged PRs (30d)
18

Description

### Dependency
- [x] #3112
- [x] #3229
- [x] #3636

### Overview
As a developer, I would like critical processes to be documented in a wiki page. In this issue, we will create a wiki page with details about the new PR columns as well as the process flow of how a PR moves through these columns.

### Details

New columns for PRs would be:

- PRs that need a reviewer assigned
- PRs that need changes from authors
- Ready for re-review (from the original reviewer)
- Reviewer has approved, waiting for merge team to merge

### Action Items
- [ ] Explore how [website-wiki pages](https://github.com/hackforla/website-wiki) are organized in our repo.
- [ ] Decide which section would be appropriate for this new wiki page.
- [ ] Understand how the GitHub action in #3112 works.
- [ ] Create a new wiki page and include a brief description for each column.
- [ ] Describe the process of how a demo PR would move through different columns.
- [ ] Add a section on different conditions which are part of the code logic, including, when a PR should stay in a column and when it should move to another column.
- [ ] Describe the responsibilities of the PR creator, reviewers as well as the merge team as part of this process.
- [ ] Since no PR would be needed for this issue, once all action items are done, reach out to the leads or merge team members for a review.

### Resources/Instructions
- [HackforLA.org (HfLA) website-wiki repo](https://github.com/hackforla/website-wiki)
- [Website repo project board](https://github.com/hackforla/website/projects/7)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the website-wiki repository organization, the website repo project board, and GitHub Action details from #3112. Create a wiki page covering the four PR columns, transitions and conditions, the responsibilities of PR creators, reviewers, and the merge team, then request review from project leads or merge team members.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.