Difference between revisions of "Cookbook"

From OpenHatch wiki
Jump to navigation Jump to search
imported>Aldeka
imported>Brittag
(undo spam blanking)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
This is the OpenHatch cookbook -- a catalog of tools and events that we have found useful for growing and improving tech meetups and open source software projects, with materials and instructions for how you can replicate and adapt them for your community!
 
This is the OpenHatch cookbook -- a catalog of tools and events that we have found useful for growing and improving tech meetups and open source software projects, with materials and instructions for how you can replicate and adapt them for your community!
 +
 +
This document is extremely in progress; please bear with us!
  
 
=== Introductory Programming Workshops ===
 
=== Introductory Programming Workshops ===
Curriculum for running an introductory programming workshop for women and their friends. [[Boston Python Workshop|Primary materials are for teaching Python]], but we also have [http://wiki.railsbridge.org/projects/railsbridge/wiki/Workshops resources for Ruby on Rails (via Railsbridge)] and Scala (forthcoming).
+
 
 +
Curricula and guides for running introductory programming workshops.
 +
 
 +
* Goal of the event: Introducing more people to programming in a way that encourages them to stick around.
 +
* Photo of one (if available): (TODO)
 +
* How to run it:  [[Boston Python Workshop| BPW curriculum]]
 +
* How OpenHatch usually helps: (TODO)
 +
* Links to blog posts etc. of past instances of the event: [https://openhatch.org/blog/2012/wrapping-up-the-6th-boston-python-workshop/ Blog post about the 6th BPW], [http://pyvideo.org/video/719/diversity-in-practice-how-the-boston-python-user Video of Jessica and Asheesh's talk about BPW]
 +
* Links to resources they'll find useful when organizing: [[Boston Python Workshop|The Boston Python Workshop for Women and Their Friends's curriculum]], [http://wiki.railsbridge.org/projects/railsbridge/wiki/Workshops Railsbridge's Ruby on Rails Workshop for Women and Their Friends curriculum], Scala curriculum (forthcoming).
  
 
=== Project Nights ===
 
=== Project Nights ===
  
A simple way to bring new people into your local tech meetup group (e.g. a Python user's group) is to run a project night. All you need is a venue (preferably with food), a few experienced developers who are willing to answer questions and mentor newcomers, a sign to mark part of the venue your "Beginner's Corner", and friendly verbiage in the marketing copy for the event (we've found that many people find "project nights" less intimidating and macho than "hack nights"). Here is a [https://openhatch.org/blog/2012/the-steps-boston-ruby-is-taking-to-become-friendly-to-beginners/ blog post] describing Boston Ruby's successful replication of Boston Python's project nights.
+
Project nights are open "hack" nights typically run by a programming user group.
 +
 
 +
* Goal of the event: Help newcomers and old hats work on programming projects, while also enabling newcomers through lightweight mentorship
 +
 
 +
* Photo of one (if available): (TODO)
 +
* How to run it: A simple way to bring new people into your local tech meetup group (e.g. a Python user's group) is to run a project night. All you need is a venue (preferably with food), a few experienced developers who are willing to answer questions and mentor newcomers, a sign to mark part of the venue your "Beginner's Corner", and friendly verbiage in the marketing copy for the event (we've found that many people find "project nights" less intimidating and macho than "hack nights").
 +
* How OpenHatch usually helps: (TODO)
 +
* Links to blog posts etc. of past instances of the event: [https://openhatch.org/blog/2012/the-steps-boston-ruby-is-taking-to-become-friendly-to-beginners/ Boston Ruby's blog post]
 +
* Links to resources they'll find useful when organizing: N/A
  
 
=== Free Software Contribution Workshops for Students ===
 
=== Free Software Contribution Workshops for Students ===
[http://campus.openhatch.org/ Open Source Comes to Campus]
+
 
 +
Two-day workshop that introduces undergraduate students to the process of contributing to free software and connects them to communities that can mentor them.
 +
 
 +
* Goal of the event: Get more undergraduate students involved in free software
 +
 
 +
* Photo of one (if available): (TODO) [https://openhatch.org/blog/2010/photos-from-penn/]
 +
* How to run it: (TODO)
 +
* How OpenHatch usually helps: (TODO)
 +
* Links to blog posts etc. of past instances of the event: [https://openhatch.org/blog/2010/photos-from-penn/]
 +
* Links to resources they'll find useful when organizing: [http://campus.openhatch.org/ Open Source Comes to Campus], [http://penn.openhatch.org/ UPenn's instance of the workshop]
  
 
=== Newcomer Inclusion Contests ===
 
=== Newcomer Inclusion Contests ===
* [[Starling|Starling bounties]]
+
 
* [http://mairin.wordpress.com/category/fedora-design-bounty/ Fedora Design Bounties]
+
Highlight specific, needed tasks to provide clear entry points for potential contributors to join your project's community.
 +
 
 +
* Goal of the event: Bring in new contributors to a FOSS project
 +
 
 +
* Photo of one:
 +
* How to run it:
 +
* How OpenHatch usually helps:
 +
* Links to blog posts etc. of past instances: [http://mairin.wordpress.com/category/fedora-design-bounty/ Fedora Design Bounties]
 +
* Links to useful resources: [[Starling|Starling bounties]]
  
 
=== Build-It Days ===
 
=== Build-It Days ===
* [[Build it]]
 
  
* Playtest your docs
+
A few hours or a day specifically spent helping new contributors set up devel installs of your project (in real life or in IRC).
  
* Make a screencast of somebody setting up a devel install of your project and put the video on your Get Involved page!
+
* Goal of the event: Have more potential contributors be technologically prepared to contribute to your project.
 +
 
 +
* Photo of one:
 +
* How to run it:
 +
* How OpenHatch usually helps:
 +
* Links to blog posts etc. of past instances: [http://mairin.wordpress.com/category/fedora-design-bounty/ Fedora Design Bounties]
 +
* Links to useful resources: [[Build it]], (TODO: docs playtesting guide, devel install screencast guide)
  
 
=== Bitesize Bugs ===
 
=== Bitesize Bugs ===
 +
 +
Tag simple, easy-to-fix bugs in your bug tracker as good for newcomers and make it easy for new contributors to find those bugs.
 +
 +
* Goal: New contributors can find bugs appropriate for their level of experience and familiarity with the project and fix them.
 +
 +
* Photo of one:
 +
* How to run it:
 +
* How OpenHatch usually helps:
 +
* Links to blog posts etc. of past instances:
 +
* Links to useful resources:
  
 
=== Community Metrics ===
 
=== Community Metrics ===
  
[http://communityleadershipsummit.wikia.com/wiki/Metrics Notes] from a CLS 2012 session on community metrics, including a [https://dl.dropbox.com/u/6302680/Community%20Metrics.pdf mind map of all (?) the community metrics one might track]
+
Setting up mechanisms for tracking how people get involved with your project and what changes might increase contribution.
 +
 
 +
* Goal: Know whether or not your FOSS project community is meeting your goals and learn what may be inhibiting community growth
  
Ubuntu's three-column Trello workflow for tracking package uploaders
+
* Photo of one:
 +
* How to run it:
 +
* How OpenHatch usually helps:
 +
* Links to blog posts etc. of past instances: [http://meta.wikimedia.org/wiki/Template_A/B_testing A/B testing of Wikipedia revert messaging] to avoid discouraging new contributors
 +
* Links to useful resources: (TODO: Ubuntu's three-column Trello workflow for tracking package uploaders), [http://communityleadershipsummit.wikia.com/wiki/Metrics Notes] from a CLS 2012 session on community metrics, including a [https://dl.dropbox.com/u/6302680/Community%20Metrics.pdf mind map of all (?) the community metrics one might track, [http://communityleadershipsummit.wikia.com/wiki/Entrance_and_exit_Surveys Notes from Asheesh's session on running surveys], [http://redmonk.com/dberkholz/2012/07/10/how-to-recruit-open-source-contributors/ Gentoo tracking GSoC student retention] using a spreadsheet plus regular check-ins with mentors
  
[http://communityleadershipsummit.wikia.com/wiki/Entrance_and_exit_Surveys Notes from Asheesh's session on running surveys]
+
=== Automated Learning Tools ===
  
[http://redmonk.com/dberkholz/2012/07/10/how-to-recruit-open-source-contributors/ Gentoo tracking GSoC student retention] using a spreadsheet plus regular check-ins with mentors
+
Creating and using plot-driven, interactive, automated tutorials for learning a new free software-related language or skill.
  
[http://meta.wikimedia.org/wiki/Template_A/B_testing A/B testing of Wikipedia revert messaging] to avoid discouraging new contributors
+
* Goal: Help newcomers learn programming languages or common FOSS tools without embarrassing themselves or demanding unnecessarily repeated effort from overworked mentors
  
=== Automated Learning Tools ===
+
* Photo of one:
* (TODO: trypython/tryruby/codecademy/codingbat/etc)
+
* How to run it:
*[http://openhatch.org/missions/ OpenHatch Training missions]
+
* How OpenHatch usually helps:
* [[Mission suggestions]]
+
* Links to blog posts etc. of past instances: [https://openhatch.org/blog/2012/1137-people-have-learned-free-software-skills-with-the-help-of-openhatchs-training-missions/]
 +
* Links to useful resources: (TODO: trypython/tryruby/codecademy/codingbat/etc), [http://openhatch.org/missions/ OpenHatch Training missions], [[Mission suggestions]]
  
 
=== Diversity Statements and Codes of Conduct ===
 
=== Diversity Statements and Codes of Conduct ===
  
* [http://www.dreamwidth.org/legal/diversity Dreamwidth's diversity statement]
+
Ways to make sure your project's messaging and community behavior are welcoming, not hostile
* [https://github.com/ginatrapani/ThinkUp/wiki/Developer-Guide ThinkUp's developer guide]: "Welcome! You are a programmer! The ThinkUp project eagerly welcomes new contributors from all communities, even if you don’t think of yourself as a programmer. (Yet!)"
+
 
* [http://geekfeminism.wikia.com/index.php?title=Conference_anti-harassment_policy Geek Feminism Wiki's example Code of Conduct for conferences]
+
* Goal: Newcomers of all sorts feel welcome in your community; assholes either behave civilly or leave.
 +
 
 +
* Photo of one:
 +
* How to do it:
 +
* How OpenHatch usually helps:
 +
* Links to blog posts etc. of past instances:
 +
* Links to useful resources: [http://www.dreamwidth.org/legal/diversity Dreamwidth's diversity statement], [https://github.com/ginatrapani/ThinkUp/wiki/Developer-Guide ThinkUp's developer guide]: "Welcome! You are a programmer! The ThinkUp project eagerly welcomes new contributors from all communities, even if you don’t think of yourself as a programmer. (Yet!)", [http://geekfeminism.wikia.com/index.php?title=Conference_anti-harassment_policy Geek Feminism Wiki's example Code of Conduct for conferences]
  
 
If you have any questions on how to run a successful event or use these materials effectively, or are otherwise interested in open tech community outreach, please sign up for the OpenHatch [http://lists.openhatch.org/mailman/listinfo/events Events mailing list].
 
If you have any questions on how to run a successful event or use these materials effectively, or are otherwise interested in open tech community outreach, please sign up for the OpenHatch [http://lists.openhatch.org/mailman/listinfo/events Events mailing list].
  
 
All of these materials are both free as in beer and free as in speech to use. If you do use them, though, we at OpenHatch would love to hear about how it goes, either on [http://lists.openhatch.org/pipermail/events/ the Events mailing list] or a guest post on [http://openhatch.org/blog/ our blog]!
 
All of these materials are both free as in beer and free as in speech to use. If you do use them, though, we at OpenHatch would love to hear about how it goes, either on [http://lists.openhatch.org/pipermail/events/ the Events mailing list] or a guest post on [http://openhatch.org/blog/ our blog]!

Latest revision as of 21:05, 2 August 2014

This is the OpenHatch cookbook -- a catalog of tools and events that we have found useful for growing and improving tech meetups and open source software projects, with materials and instructions for how you can replicate and adapt them for your community!

This document is extremely in progress; please bear with us!

Introductory Programming Workshops[edit]

Curricula and guides for running introductory programming workshops.

Project Nights[edit]

Project nights are open "hack" nights typically run by a programming user group.

  • Goal of the event: Help newcomers and old hats work on programming projects, while also enabling newcomers through lightweight mentorship
  • Photo of one (if available): (TODO)
  • How to run it: A simple way to bring new people into your local tech meetup group (e.g. a Python user's group) is to run a project night. All you need is a venue (preferably with food), a few experienced developers who are willing to answer questions and mentor newcomers, a sign to mark part of the venue your "Beginner's Corner", and friendly verbiage in the marketing copy for the event (we've found that many people find "project nights" less intimidating and macho than "hack nights").
  • How OpenHatch usually helps: (TODO)
  • Links to blog posts etc. of past instances of the event: Boston Ruby's blog post
  • Links to resources they'll find useful when organizing: N/A

Free Software Contribution Workshops for Students[edit]

Two-day workshop that introduces undergraduate students to the process of contributing to free software and connects them to communities that can mentor them.

  • Goal of the event: Get more undergraduate students involved in free software

Newcomer Inclusion Contests[edit]

Highlight specific, needed tasks to provide clear entry points for potential contributors to join your project's community.

  • Goal of the event: Bring in new contributors to a FOSS project

Build-It Days[edit]

A few hours or a day specifically spent helping new contributors set up devel installs of your project (in real life or in IRC).

  • Goal of the event: Have more potential contributors be technologically prepared to contribute to your project.
  • Photo of one:
  • How to run it:
  • How OpenHatch usually helps:
  • Links to blog posts etc. of past instances: Fedora Design Bounties
  • Links to useful resources: Build it, (TODO: docs playtesting guide, devel install screencast guide)

Bitesize Bugs[edit]

Tag simple, easy-to-fix bugs in your bug tracker as good for newcomers and make it easy for new contributors to find those bugs.

  • Goal: New contributors can find bugs appropriate for their level of experience and familiarity with the project and fix them.
  • Photo of one:
  • How to run it:
  • How OpenHatch usually helps:
  • Links to blog posts etc. of past instances:
  • Links to useful resources:

Community Metrics[edit]

Setting up mechanisms for tracking how people get involved with your project and what changes might increase contribution.

  • Goal: Know whether or not your FOSS project community is meeting your goals and learn what may be inhibiting community growth

Automated Learning Tools[edit]

Creating and using plot-driven, interactive, automated tutorials for learning a new free software-related language or skill.

  • Goal: Help newcomers learn programming languages or common FOSS tools without embarrassing themselves or demanding unnecessarily repeated effort from overworked mentors

Diversity Statements and Codes of Conduct[edit]

Ways to make sure your project's messaging and community behavior are welcoming, not hostile

  • Goal: Newcomers of all sorts feel welcome in your community; assholes either behave civilly or leave.

If you have any questions on how to run a successful event or use these materials effectively, or are otherwise interested in open tech community outreach, please sign up for the OpenHatch Events mailing list.

All of these materials are both free as in beer and free as in speech to use. If you do use them, though, we at OpenHatch would love to hear about how it goes, either on the Events mailing list or a guest post on our blog!