Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save ALRubinger/5d933b530fae307bf47a50d5f72f042d to your computer and use it in GitHub Desktop.
Save ALRubinger/5d933b530fae307bf47a50d5f72f042d to your computer and use it in GitHub Desktop.
HackMD / Git Technique for Collaborative Editing
* At the beginning of each week, Nick and I talk broadly about our goals for the week. We're finding it's a nice block of time we can wrap our heads around with planning. We think about that week in context of a grander Milestone, for instance the upcoming Phase2 work for the dev site we want out by end of this month.
* All of those scoping documents live here in a table: https://github.com/TBD54566975/collaboration/tree/main/planning
* For the current week, while things are in flux, we start from the template which helps us organize our thoughts. That template is here: https://github.com/TBD54566975/collaboration/blob/main/planning/open-source-programs/weekly/OSP_WEEKLY_SCOPING_TEMPLATE.md
* We copy that template into a new HackMD doc. And set permissions on that HackMD to "public viewable by everyone and editable by logged-in users". Then we commit that link to the planning index page.
* ...because HackMD lets you see real-time edits from others, and comment on specific sections and have a conversation there, much like Google Docs.
* Throughout the week we collaboratively edit the HackMD
* At the end of the week, we take stock of whether we hit our goals, and do a retro on whether things worked well and we should keep/expand/change or processes to do better
* Then that HackMD we copy/paste into a new Markdown file in Git and commit it alongside the files from past weeks.
* ...and update the index to link to the new file in GitHub rather than the Hack MD.
* Rinse and repeat.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment