hackforla / hackforla/311-data

Epic: Review and Update our Contributing file to reflect our dev workflow and processes

Open
#1,939 0 comments 0 reactions 1 assignee Claimed by @rayneng View on GitHub
Complexity: Small Epic Feature: Documentation Role: Frontend size: 0.50pt
Dominant language
JavaScript
Stars
73
Forks
74
PR merge metrics
No merged PRs in 30d

Description

### Overview
We need to update our Contributing file so that it reflects the desired workflow and processes for devs on the 311 Data team.

### More Info

This epic tracks all issues related to the file, CONTRIBUTING.md

### Action Items

- [ ] https://github.com/hackforla/311-data/issues/1963
- Enumerate useful rules from the website team's Contributing file that can be incorporated into our Contributing file
- [x] https://github.com/hackforla/311-data/issues/1962
- Make the 311 Data team's Contributing file be all caps: `CONTRIBUTING.md`
- [ ] https://github.com/hackforla/311-data/issues/1953
- [ ] Rule: Open PRs must be first reviewed by a dev before being reviewed by the dev lead
- [ ] Rule: PRs must request a specific person for review
- this allows the PR notification to specify who the PR is waiting on
- [ ] Rule: PRs need WIP in title to specify that the PR is still being worked on, and that it should not receive PR notifications
- [ ] Rule: Creating a PR from a forked branch
- [ ] Rule: PR should include instructions for how to check out your fork's branch
- [ ] reference: https://github.com/hackforla/website/wiki/How-to-Review-Pull-Requests
- [ ] example: https://github.com/hackforla/website/pull/7987#issuecomment-2711522263
- [ ] TODO: Tickets for modifying the Contributing file can go here

### Resources/Instructions
- Contributing File Rule Tracker: https://docs.google.com/spreadsheets/d/1XaxJSJYuD54PIiZVX5tBf2POiVR1KHwXB7bbuzd3eVs/edit?gid=0#gid=0
- useful Website repo files:
- https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md
- https://github.com/hackforla/website/blob/gh-pages/README.md
- useful 311-Data repo files
- https://github.com/hackforla/311-data/blob/main/contributing.md
- https://github.com/hackforla/311-data/blob/main/README.md

Click to see: Suggested instructions on creating a PR from a forked branch

Author: ChatGPT, the internet

1. Go to Your Fork: Navigate to your fork of 311-Data on GitHub.
2. Switch to the Branch: Select the branch you want to merge from.
3. Click on "Contribute" > "Open pull request": GitHub will suggest merging your fork’s branch into the default branch of 311-Data (e.g., main).
4. Change the Base Branch:
1. Below "base repository," ensure the dropdown is set to 311-Data.
2. Change the target branch from main to the branch you want to merge into.
5. Submit the PR: Add a title, description, and submit.

CLI Instructions

1. Add the Upstream Repository (if you haven’t already):git remote add upstream https://github.com/311-Data/311-Data.git
2. Fetch the Latest Changes: `git fetch upstream`
3. Create a New Branch Tracking the Upstream Branch: `git checkout -b your-branch-name upstream/target-branch`
4. Merge Your Fork’s Branch into This New Branch: `git merge origin/your-branch-name`
5. Resolve any conflicts if necessary.
6. Push the Branch to 311-Data: `git push upstream your-branch-name`
7. Open a PR in GitHub: Go to the 311-Data repo and create a PR from your new branch into the target branch.


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.