-
-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create a Guide/Template: Readme for your project #76
Comments
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
@Olivia-Chiong
|
@Rabia2219 It looks like this issue is not yet complete. Here are my suggestions for improvement
|
Prior version of issue
OverviewWe 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
ResourcesUpdate issue #104 with the name of item you are working Projects that have been checked
Projects that have not been checked
Inactive or completed projects (do not use for examples)Readme for Civic Opportunity Project |
Files in this issue:
|
@Rabia2219 This guide issue is moving to the knowledgebase-content repo. If you would like to maintain edit access to the issue and its associated files, please fill out the Google Drive Access Form. |
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.
Resources/Instructions
Projects that have been checked
Projects that have not been checked
Inactive or completed projects (do not use for examples)
Readme for Civic Opportunity Project
Readme for Railstats LA
Tasks
The text was updated successfully, but these errors were encountered: