Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

\uD83D\uDDD3 Date

\uD83D\uDC65 Participants

\uD83E\uDD45 Goals

  • Review documentation list

  • Patterns and expectations work planning

  • Documentation update planning

\uD83D\uDDE3 Discussion topics

Item

Presenter

Notes

 

existing developer onboarding resources, across any technologies, to this spreadsheet: https://docs.google.com/spreadsheets/d/1b6DDiikSwo_kOUbU_3htLVc_gsp3PPFvzMzu2QIdUJk/edit?usp=sharing

Building a contribution guide – Resources Heather found from Open Source 101 talks:

  1. Docs or it didn’t happen (the WordPress documentation case study)  – Milana Cap, XWP

  2. Open Source Is Not Just About Code: Effective Strategies for Collaboration – Ben Greenberg, New Relic

Tips for creating a contribution guide:

  • Make it clear what do you want people to know, do, and why they should care.

  • quality readme to answer these questions quickly. Reduces ambiguous language. New Relic Phoenix demo application for an example.

  • don't assume knowledge, tell people what you expect of them, transparency in the process of committing a pull request including time it takes

  • good first issues, badges, labels, name people for help

  • concise readme with badges, transparent contributing guide, link to CoC and anti-harassment, organize with labels, create a plan that is flexible and adaptable


Heather


Next steps for documentation review/update

Next steps for pattern and practice guidence

Other items

✅ Action items

  •  

⤴ Decisions