hackforla / hackforla/peopledepot

Documentation on PR expectations

Open
#535 0 comments 0 reactions 0 assignees View on GitHub
complexity: small draft feature: docs: PD team documentation PII: FALSE role: writing s: PD team size: 2pt
Dominant language
Python
Stars
14
Forks
37
Avg merge
9d 15h
Merged PRs (30d)
5

Description

### Overview

We need to make sure there's a checklist for contributors to follow for creating a PR. This probably falls on the wiki side of documentation

### Action Items

- [ ] create a wiki page with a checklist for a PR
- [ ] create link(s) from mkdocs documentation

### Resources/Instructions

Start from the example below

---

Checklist

- [ ] PR should be from a branch in a fork to `peopledepot/main`
- [ ] Title should summarize the PR changes
- [ ] Description should follow the PR template with issue number, etc.
- [ ] What changes were made and how do the changes satisfy the requirements.
- [ ] Code should be run-able
- [ ] Changes should implement what the issue requires with no unrelated changes
- [ ] Changes should not modify/break existing functionality
- [ ] Changes should include adequate tests
- [ ] Changes should include relevant documentation

Requesting reviews

We do a 2-review process share the work among all team members.

1. Assign the PR to a team member and notify them via slack that it's ready to review.
1. Wait for review
1. Make any requested changes via new commits so it's clear what the new changes are.
1. Rebase to `hackforla/main` if new changes were merged, and retest the code.
1. Request a review
1. Assign the PR to a lead and notify them via slack.
1. Same process as above.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.