Feds publish guide to setting up an open source project

GitHub

18F has published a guide that helps federal government workers standardize GitHub use and better leverage the social coding platform when setting up open source projects.

Tips include how to best name and describe projects, create readable READMEs , write user story focused issues, wiki best practices and a GitHub repo checklist.

Additional thoughts that would make the guide more helpful:

  • Add a section on collaborators and permissions.
  • Encourage including a link for the ‘Website for this repository’ next to the description whenever possible.
  • Next to the ‘Edit this page’ link, add a ‘Submit feedback’ link to the issues section for the guide so it’s easier to giv feedback. In general, if you’re going to have either option, it’s best to have both, especially the latter.
  • One bug: The images on https://pages.18f.gov/open-source-guide/using-the-wiki aren’t responsive.

Update:

About Luke Fretwell

Luke Fretwell is the founder of GovFresh. He is also co-founder and CEO of ProudCity. Connect with him on Twitter and LinkedIn or email at luke@govfresh.com.

Comment