Include a project description that explains what your project is and why it exists. Aim for no more than 3-5 concise sentences. For example, you might say:
{Project Name} is a project of Hack for LA. Hack for LA is a brigade of a Code for America that exists to {your mission}. {Project Name} helps {target users} accomplish {goal of project}. The {app/site/thing you're building}'s main features include {very brief feature descriptions}.
Civic projects often exist within a larger context that may include multiple stakeholders, historic relationships, associated research, or other details that are relevant but not required for direct contributions. Gathering these details in one place is useful, but the ReadMe isn't that place. Use this section to link to a Google Doc or other documentation repository where contributors can dig in if they so choose. This is also a good place to link to your Code of Conduct.
Explain the different ways people can contribute. For example:
- Join the team {on Slack/at our weekly hack night/etc}.
- To help with user research, {do ABC}.
- To provide design support, {do XYZ}.
- To contribute to the code, see the contributing document.
Remember to provide direct links to each channel.
Include at least one way (or more, if possible) to reach your team with questions or comments.
Include details about the project's open source status.