hackforla / hackforla/knowledgebase-content

Create a Guide/Template: Making a good CONTRIBUTING doc for your project's github repo

Open
#158 4 comments 0 reactions 0 assignees View on GitHub
Complexity: Missing CoP label: checked CoP label: shortcuts added CoP: Engineering drive: knowlegebase milestone: missing Phase: 1 - Gather Examples Solo Ready for Bonnie Triage size: missing status: 1.1 needs wiki examples status: 1.2 needs issues examples status: 1.3 needs project board examples status: 1.4 needs slack examples
Dominant language
No language data
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

### Overview
We need to create a guide to making a CONTRIBUTING.md file for a HackforLA projects so that new engineers on projects can get started easily no matter their skill level.
### Action Items
The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.
- [ ] [Gather Examples Solo](https://github.com/hackforla/guides/wiki/How-to-Gather-Examples:-Solo) (open in a new tab)
- [ ] [Gather Examples Collaboratively](https://github.com/hackforla/guides/wiki/Phase-2-%E2%80%90-Gather-Examples-Collaboratively)
- [ ] [Create a Guide Draft](https://github.com/hackforla/guides/wiki/How-to-Draft-a-Guide)
- [ ] If needed, create a template
- [ ] [Have your guide peer reviewed](https://github.com/hackforla/guides/wiki/Peer-Reviews-for-Guides)
- [ ] [Present your guide for leadership review](https://github.com/hackforla/guides/wiki/Submitting-Your-Guide-for-Leadership-Review)
### Resources/Instructions
Google Drive Folder for this Guide’s documents and shortcuts (to documents in other locations) [0158 [DRAFT] Making a good CONTRIBUTING doc for your project's github repo](https://drive.google.com/drive/folders/1NtwajfGWPvWIxTD8ZG8ItDjkV5HRuu-c)
- [GitHub's guidance for contributing files](https://docs.github.com/en/github/building-a-strong-community/setting-guidelines-for-repository-contributors#adding-a-contributing-file)
- [100Automations guide for CONTRIBUTING files](https://github.com/100Automations/Website/blob/gh-pages/_guides/community-support-for-automations.md#contributing)
- [Hack for LA website team's CONTRIBUTING.md file](https://github.com/hackforla/website/blob/gh-pages/CONTRIBUTING.md)
- [311-data's contributing.md file](https://github.com/hackforla/311-data/blob/dev/docs/contributing.md)
- [100 Automation's CONTRIBUTING.md](https://github.com/100Automations/Website/blob/gh-pages/CONTRIBUTING.md)
- [CivicTechJobs's CONTRIBUTING.md](https://github.com/hackforla/CivicTechJobs/blob/main/CONTRIBUTING.md)
- [Lucky Parking CONTRIBUTING.MD](https://github.com/hackforla/knowledgebase-content/issues/158)
- [VRMS README.md](https://github.com/hackforla/VRMS/blob/development/README.md): not a contributing file but has information like that on a contributing file
- [TDM Calculator Contributing Code](https://github.com/hackforla/tdm-calculator/wiki/Contributing-Code)
- [Food Oasis Contributing Code](https://github.com/hackforla/food-oasis/wiki/Contributing-Code)

**Projects with no contributing information or file:**

- [Expunge-Assist](https://github.com/hackforla/expunge-assist)
- [Access the data](https://github.com/hackforla/access-the-data/)

### Projects to Check
### Tasks
- [ ] This is where you will copy instructions from the wiki page for the step you are currently on.

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.