contributor-experience/handbook

Create a style guide and/or templates for this project to support new contributors

Opened this issue · 1 comments

Linked to #38 #7 and following discussions on #35, I'd like to suggest creating a style guide and some templates to help new and returning participants successfully contribute high quality content.

Reasons for the style guide and templates include:

  • Maintain consistency across different pieces of content
  • Help new contributors understand how to format and structure their work
  • Highlight less obvious aspects of contributing (e.g. unusual file names, or auxiliary files that also need to be changed when new content is added)
  • Support inclusion and diversity efforts by providing accessibility and language guidance

How can people help with this?

  • Suggest examples of good style guides
  • Create template files
  • Help write the style guide
  • Provide feedback on the guides and templates
  • Update and maintain templates and guides when something changes

Some suggestions for the style guide:

  • Follow APA Style for formatting content on the website.
  • Not to capitalize the phrase “open source” unless other rules overwriting it.
    cc @melissawm @noatamir