hackforla / hackforla/knowledgebase-content
Create a Guide/Template: Readme for your project
- Vorherrschende Sprache
- Keine Sprachdaten
- Sterne
- 2
- Forks
- 1
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
### Overview
We need to create a guide to making the Readme file of every project. This file should have the information people may need before they start contributing to the project. Typically for a software project that would be an overview, goals, development process, technology, etc.
### 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.
- [x] [Gather Examples Solo](https://github.com/hackforla/guides/wiki/How-to-Gather-Examples:-Solo) (open in a new tab)
- [x] [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) [0076 [DRAFT] Readme for your project](https://drive.google.com/drive/folders/1KtDnH4LUKg_mie2bY8ohYxsFt3chxar-)
- Guide Draft [Guide: Readme DRAFT
](https://docs.google.com/document/d/1fXGwBUv8qKL1HcnoYkVwx0aWwYyuwbIATKYbT8nRSbI/edit)
- [A curated list of awesome READMEs from non HfLA repos](https://github.com/matiassingers/awesome-readme)
### Projects that have been checked
- [100 Automations](https://github.com/100automations/website)
- [readme](https://github.com/100Automations/Website/blob/gh-pages/README.md)
- [BallotNav](https://github.com/hackforla/ballotnav)
- [Readme for BallotNav](https://github.com/hackforla/ballotnav#readme)
- [Expunge-Assist (formerly known as Record Clearance)](https://github.com/hackforla/expunge-assist)
- [Readme for Expunge Assist](https://github.com/hackforla/expunge-assist/blob/master/README.md)
- [Food Oasis](https://github.com/hackforla/food-oasis)
- [Readme for Food Oasis](https://github.com/hackforla/food-oasis/blob/develop/README.md)
- [Lucky Parking](https://github.com/hackforla/lucky-parking)
- [Readme for Lucky Parking](https://github.com/hackforla/lucky-parking/blob/master/README.md)
### Projects that have not been checked
- [311 Data](https://github.com/hackforla/311-data)
- [Access the Data](https://github.com/hackforla/access-the-data)
- [Brigade Organizer's Playbook](https://github.com/codeforamerica/brigade-playbook)
- [Civic Tech Index](https://github.com/civictechindex/CTI-website-frontend)
- [Civic Tech Jobs](https://github.com/hackforla/CivicTechJobs)
- [Civic Tech Structure](https://github.com/hackforla/civic-tech-structure)
- [Data Science Projects](https://github.com/hackforla/data-science)
- [Design Systems](https://github.com/hackforla/design-systems)
- [Engage](https://github.com/hackla-engage)
- [GreenEarthOS](https://github.com/hackforla/climate-project)
- [Guides](https://github.com/hackforla/guides)
- [HomeUniteUs](https://github.com/hackforla/homeuniteus)
- [Internship project](https://github.com/hackforla/intership)
- [Open Community Survey](https://github.com/hackforla/open-community-survey)
- [TDM Calculator](https://github.com/hackforla/tdm-calculator)
- [VRMS](https://github.com/hackforla/vrms)
- [Hack for LA's Website](https://github.com/hackforla/website)
- [Youth Justice Nav](https://github.com/hackforla/YouthJusticeNav/)
### Inactive or completed projects (do not use for examples)
[Readme for Civic Opportunity Project ](https://github.com/hackforla/civic-opportunity/blob/master/README.md)
[Readme for Railstats LA](https://github.com/metro-ontime/performance_tracker/blob/master/README.md)
### Tasks
- [ ] This is where you will copy instructions from the wiki page for the step you are currently on.
Beitragsleitfaden
Bewertung
Dieses Issue wurde noch nicht bewertet.