Introducing setup sprints
On Tuesday night we had our first official setup sprint – an IRC get together where OpenHatch volunteers test an open source project’s installation and contribution process and documentation. Our inaugural project was Oppia, a tool which helps non-technical users create interactive educational activities online. Three volunteers (Carol Willing, Anurag, and myself) spent two and a half hours working with Oppia maintainer Sean Lip testing and improving documentation. The quick, casual feedback process meant we made a bunch of changes, including restructuring the documentation to be easier to navigate, adding explanations (and/or links to tutorials/guides) where documentation was too terse, and changing the output of the testing suite to be more understandable. We also managed to create the project’s 100th issue.
Although there’s always more work to do, we’re pleased to say that Oppia is ready for students to contribute to at our Open Source Comes to Campus events, including the next one on March 9th at UMass-Amherst.
If you’re interested in welcoming new contributors to your project by having it featured at our events, check out our OpenHatch-Affiliated Projects page. It explains in detail the steps needed to get your project ready. It also explains why we run setup sprints: “A sprint will help you quickly find and fix problems with dependencies, documentation, and more.” Or, as Sean remarked during the sprint: “It’s very helpful to have a tight feedback loop with these things.”
If you’d like to contribute to open source projects by participating in these sprints, let us know and we’ll make sure you get a heads up before they happen. The next one should be soon!
Goals for Open Source Comes to Campus in 2014
At OpenHatch we have big dreams. One of them? Keeping better track of our dreams.
When we sat down a few months ago to make a plan for 2014, we regretted not creating clear and public goals at the start of 2013. By committing to specific goals, and promising to measure and report the results, we’re pushing ourselves to make progress. In the spirit of progress, here are our goals for 2014.
Increase the number of Open Source Comes to Campus events, and make them easier for others to run.
Why: Last year we had many more invitations to run events than we, with our small team, could possibly accept. We’re only human – and we don’t want our humanity to keep students from being introduced to open source! While we will continue planning and attending workshops ourselves, we’re focused on making it so anyone, anywhere can run an Open Source Comes to Campus workshop.
How: In phase one, we documented our planning process and put all of our materials – curriculum, publicity, etc – online. Phase two, currently underway, involves recruiting schools to run events and using their feedback to improve our process.
Measured by:
- Number of events: We hope to double the number of Open Source Comes to Campus events, from 12 in 2013 to 24 in 2014.
- Feedback from events: For each event, we will elicit feedback in the form of surveys from students and mentors, and have debriefings with organizers. We hope to see a positive trend in the surveys. A positive trend would be an improvement of the average rating by 1 point or more (on a scale of 1-4).
- Hands-off events: We plan to run at least one event with minimal-to-no involvement on the part of OpenHatch organizers. We hope our surveys show that these events are just as successful as those we have a more active role in.
- Repeated events: It’s as good a sign as you can get when organizers want to run more events. We’re hoping to run at least six repeat events this year, and for at least half our event organizers in 2014 to express interest in a repeat event.
Improve the Open Source Comes to Campus curriculum
Why: We’ve worked hard on our curriculum, and have seen the payoff from that in a few key areas. Over the course of eight months and a lot of trial and error, our introduction to version control went from a confusing, too-long lecture to a well-liked, hands-on activity. We want all of our curriculum to be as well-received as Practicing Git – and we’d like to offer more curriculum options for organizers, so they can tailor events to the needs and interest of their participants.
How: Through feedback, we’ve identified the ‘Contributions Workshop’ as the element of our events that needs the most work. We’ve also identified the ‘History and Ethics of Free Software’ section as needing significant improvement. We will continue to brainstorm ways to improve the activities and test those changes by eliciting feedback from attendees and mentors. We’ll also talk to event organizers and community members about what new curriculum elements to add and how to add them.
Measured by:
- Existing weak areas: For the ‘Contributions Workshop’ and ‘History and Ethics of Free Software’, we hope to go through at least one new iteration of the activity, and to see a positive trend in survey evaluations of these activities.
- New sections: We hope to add at least two new sections to the curriculum. Current ideas for sections include more openly discussing the mental blocks that keep people from contributing to software, an expanded IRC activity, and an introduction to Linux (either through installations, or a virtual machine).
Partner with open source projects to help students form relationships with communities.
Why: While it’s great to see students submit pull requests at our events and get their changes merged, the truth is that most open source contributions – especially to new projects – don’t take place in an hour or two, even for open source veterans. We’re refocusing our efforts on helping students connect with open source projects that will welcome them into their communities.
How: We’re going to recruit OpenHatch-affiliated projects to participate in Open Source Comes to Campus. We’ll work with these projects to improve their guides and introductory materials, and to help them identify good tasks for students. After events, we’ll help projects follow up with students. We’ll be a resource to help students continue to contribute.
Measured by:
- 10 OpenHatch-affiliated projects: We hope to have at least ten such projects actively participating in our events by the end of the year.
- 2 new contributors per project: For each affiliated project, we hope to help them find at least two ongoing contributors from among our students. An ongoing contributor is a student who has made at least one new contribution to the project, separate from what they worked on at the Open Source Comes to Campus event.
Keep students involved in the community after events are over.
Why: We’ve been so focused on improving our events that we’ve neglected the important work of following up with students and seeing how involved they’ve become with open source. While there’s a lot of value in simply knowing more about open source and how to use it, we do hope that some of our students continue to contribute to the community. We want to see if our students are staying involved and, through outreach, help them do so.
How: Most students will work one-on-one or in small groups with at least one mentor during the event. We will ask mentors to take brief notes on their students – their level of enthusiasm, their interests, and the types of problems they encountered. We will also gauge student interest through our exit surveys. We plan to follow up with every student who submits an exit survey as well as every student we receive feedback about from a mentor. Additionally, we plan to do some community-building around OSCTC alumni and organizers.
Measured by:
- Identifying students: We will attempt to collect contact information and notes on interests and goals for at least half of students at each event.
- Following up with students: We, or a local organizer, will attempt to follow up with 100% of students we’ve collected contact information for. We hope that 20% or more of those students will go on to participate in the community (or will already be doing so).
- Community events: We plan to host community events for students, including: a monthly online meetup for OSCTC alumni on IRC; a monthly online meetup for OSCTC and other open source organizers on IRC; and 5 in person meetups for alumni in Boston and San Francisco.
- Using the mailing list: Our alumni mailing list is currently very quiet. We plan to start sending a monthly email to attendees letting them know about opportunities available to them and events in their area.
How you can help
If you want to help us reach our goals, there are a lot of things you can do.
To help us increase the number of Open Source Comes to Campus events you can invite us to your school!
To help us improve the Open Source Comes to Campus curriculum you can test out our current curriculum and give us feedback. This is especially great if you’re new to one of the topics, such as git, or navigating bug trackers. You can also help us develop new activities.
To help us partner with open source projects you can talk to us about what it would take to make your project an OpenHatch-affiliated project.
To help us keep students involved in the community you can send us information about opportunities such as Google Summer of Code or good tutorials/resources that we can send their way.
Watch this space
I’ll be revisiting this post over the course of the year to check our progress towards our goals. And in December, I’ll make another post letting you know how we did. See you then!
OpenHatch newsletter, January 2014
Welcome to OpenHatch newsletter number 18.
OpenHatch at Grace Hopper Open Source Day:
Two events – one past, one future – have come out of Open Source Day. Sri Raga Velagapudi, our technical facilitator, invited us to Rutgers. Within two weeks we were able to pull togethera great event! We’ve also been in touch with Andrea Frost, Director of Leadership Development for Western Washington University’s Association for Women in Computing, who hopes to run an Open Source Comes to Campus event at her school sometime this year. Andrea emailed us soon after the event to say “thank you so much for taking the time to walk us through the tutorial. My classmate and I were attending our first open source event ever in our lives, and we were a bit intimidated at the beginning. It was great to meet your team and to have some fun in a group setting.” Needless to say, this is the kind of email that makes our work feel worthwhile.
Open Source Comes to Campus: notes and photos of events at University of Minnesota at Morris and Columbia.
We’re setting our Open Source Comes to Campus schedule for the winter/spring semester. Interested in volunteering for a local event or helping remotely? Have a potential sponsor? Get in touch.
On January 4, several contributors, including brand-new contributors, met up at a cafe in San Francisco to work on an OpenHatch website sprint! We used our own advice from the In-Person Event Handbook for organizing it. We reviewed a pile of pull requests, edited documentation, fixed some bugs, and ate tasty sandwiches – see Asheesh’s extensive notes on the mailing list.
Practical thread on OH-events list concerning how to approach disengaged attendees.
“I had a student stop by the office today and tell me that Saturday’s event was a real game changer for him.”
New projects in the OpenHatch volunteer opportunity finder
- python-requests, “an Apache2 Licensed HTTP library, written in Python, for human beings”.
- Retroshare, a “cross-platform, Friend-2-Friend and secure decentralised communication platform”.
OpenHatchy but not OpenHatch things around the web
Video of Linux.conf.us talks by Ashe Dryden (Programming Diversity) and Karen Sandler (Bringing More Women to Free and Open Source Software).
Planet Women in Free Software aggregate blog.
Leslie Hawthorn’s Nerd Story: What You Say to Young Girls Matters.
The third, and perhaps most important strength of Python is its user community. I’m sure this will be the most controversial part of this post, but I’ve found the Python community has bar-none the most supportive users. This is not by accident, but part of Python’s legacy and current commitment to inclusion. Python came from a teaching language background, and documentation was, and continues to be part of that legacy. Python is used as a teaching language in High Schools as well as MIT.
In addition, the Python Foundation focuses a lot of attention and energy into community diversity through its Diversity Statement, as well as commitment to bring women into the community, both through their own local communities (PyLadies) but also focusing on bringing that diversity into mainline events such as PyCon. The net effect is that Python is not only welcoming to women, but has a general welcoming atmosphere to people of virtually any background.
Also check out links submitted to /r/openhatch, and add your finds!
Get involved
You can help write this newsletter! The February newsletter in progress. Join our publicity list or hop on #openhatch with suggestions and questions.
Thanks to Britta Gustafson and Shauna Gordon-McKeon for contributing to this edition!
OpenHatch at Grace Hopper Open Source Day
Last fall, at the end of our tour of the midwest, OpenHatch had the pleasure of participating in the Grace Hopper Celebration of Women in Computing’s Open Source Day.
Open Source Day is an open source hackathon taking place on last day of the conference, a smoothly run event which draws hundreds of attendees and dozens of participating projects. This was our first time at Open Source Day, and definitely not our last. You can see our pictures from the event here.
We got a chance to teach: we ran our Practicing Git activity several times, first for our own volunteers and then for volunteers working on other projects. We also learned from the event organizers. They put a great deal of emphasis on preparing projects for the event. We were asked to provide set up instructions, identify tasks for attendees covering a range of skills, and were assigned a technical facilitator. This process was wildly successful, for our project as well as the others at the event. The experience has pushed us to focus on building relationships with a smaller number of interested projects rather than trying to have tasks from all the projects in our tracker.
Two events – one past, one future – have come out of Open Source Day. Sri Raga Velagapudi, our technical facilitator, invited us to Rutgers. Within two weeks we were able to pull together a great event! We’ve also been in touch with Andrea Frost, Director of Leadership Development for Western Washington University’s Association for Women in Computing, who hopes to run an Open Source Comes to Campus event at her school sometime this year. Andrea emailed us soon after the event to say “thank you so much for taking the time to walk us through the tutorial. My classmate and I were attending our first open source event ever in our lives, and we were a bit intimidated at the beginning. It was great to meet your team and to have some fun in a group setting.” Needless to say, this is the kind of email that makes our work feel worthwhile.
Many thanks to the event’s excellent organizers. We’re also grateful to Sri, and to volunteer mentors Carol Willing and Dan Flies, for helping us participate in the event. Most of all, thank you to the thirteen wonderful attendees who worked with us to improve OpenHatch!
Teaching Open Source at Columbia University
On Saturday, October 19th, we ran our sixteenth Open Source Comes to Campus event, at Columbia University. Thanks to Columbia University’s Women in Computer Science and the Application Development Initiative for hosting! Check out the gallery of the best photos from the event (and the other ones).
Staff
Ivete Tecedor, rmo, Emily Chen, Sri Raga Velagapudi, Shauna Gordon-McKeon
Selected Contributions
- Mentor Ivete describes her experience working with a handful of students: While browsing some projects using open government data, we noticed a bug in opencongress.com‘s member stats, where a few members had a rank that was higher than the total count of members, so that is clearly incorrect. We started by filing a bug in the Github repo’s issue tracker and then went looking at the calculation of that number. While we were working through that, we happened to read on opencongress.com‘s homepage that they are redoing the site and will launch a whole new site within the next month. We decided to stop trying to fix the bug since the fix would probably go unused, but left the ticket open so that the maintainers could be aware of it. And one of them commented on the bug the next day, confirming it!
- Several students worked on getting the NLTK development environment set up and on understanding some of the issues reported in the NLTK issue tracker.
- Another student looked at a feature request for Tomboy a desktop note-taking application. Unfortunately a slow internet connection meant he could not download the libraries needed to work on the project, but he was able to verify that the feature had not yet been added and located where in the project changes would need to be made.
- One student was very interested in the projects maintained by the Sunlight Foundation. He downloaded several repositories and browsed through the contents, then headed over to the OpenStates IRC channel where he worked with maintainers to updated issues in the bug tracker.
Notes
- We had 29 students attend this event. Students were very prompt – many of them even arrived before breakfast! – and most stayed throughout the day. Our process for getting latecomers caught up seems to be improving as well.
- Our last event, at Morris, had showed us the need to develop a more extensive git curriculum for more experienced attendees. Although we weren’t able to extend the curriculum in the short span of time between the two events, we made sure to group the more experienced students with our most git-savvy instructors. Special thanks to Ivete and rmo for leading students on an impromtu tour of advanced git. Feedback from Ivete, rmo, and their groups has helped us determine which topics to cover in the extended lesson.
- We recommended explainshell to students as a great resource for learning about the linux command line. This sparked a discussion about how the tool could be enhanced and what steps students might take to contribute, such as submitting a feature request or forking the project.
- We were excited to have Princeton’s Katherine Ye attending the event. Katherine was interested in organizing an Open Source Comes to Campus event at Princeton and wanted to see what it was like. Just one month later, the Princeton event was a reality! We’re always excited to have organizers attend our events and get a feel for what they’re like, so if you’re interested in running an event, let us know and we’ll make sure you’re invited to any in your area.
Teaching Open Source at Morris
On Saturday, September 28th we ran our fifteenth Open Source Comes to Campus event, at the University of Minnesota at Morris. Thanks to the Computer Science Discipline for hosting! Check out the gallery of the best photos from the event (and the other ones).
Staff
Elena Machkasova, Nic McPhee, Kristin Lamberty, Jim Hall, Alex Jarvis, Dan Flies, Matt Hardy, Shauna Gordon-McKeon, Asheesh Laroia
Selected Contributions
- One of the cooler open source projects we’ve had for students to work on was Jim Hall’s Simple Senet. He worked with a student to give users the ability to tweak rule settings. Along the way they played some senet, which looked like a lot of fun.
- Another student looked at an old patch that had been submitted to SVG-edit and found one of the issues it addressed had already been fixed. She also found that it did not effect the other issue it addressed.
- One student reproduced a behavior in Firefox but questioned whether it was really a bug.
- Another student reproduced a bug in FBReaderJ.
- A group of students and mentors worked together to fix a bug in wordpress. That’s them above, still working on it after the event was technically over.
Notes
- We had a truly exceptional team of mentors for this event: the entire tenured Computer Science faculty at Morris (Elena, KK, and Nic); open source veteran Jim Hall; and a great group of alumni who were in Morris for homecoming weekend (Alex, Dan and Matt). Everyone knew someone else in the room – some people knew everyone else in the room! – and this level of ease and friendliness made for a great day. There was a lot of fun IRC chatter, the career panel was lively and ran long, and students seemed very comfortable asking for help.
- The above experience left us wondering: how can we promote this kind of atmosphere at events hosted in communities that are not quite as close knit? Ice-breaker and social activities may be just as important to success as any of our technical training.
- There was a small group of more experienced students who were already familiar with git, and were consequently pretty bored with the Practicing Git activity. This experience inspired us to expand the git lesson to include more advanced topics such as branching, merging, and multiple remotes. It also reinforced the importance of finding out about attendees’ experience levels ahead of time.
- Speaking of the Practicing Git activity, one of the groups produced the best website to date. For certain definitions of “best”.
- CS faculty member and host organizer Elena Machkasova introduced many of us to the concept of code poems with her poem written in Clojure.
- At the event, student Andrew Latterner announced the start of an Open Source Development Club. We wish Andrew good luck and great success!
OpenHatch newsletter, December 2013
Welcome to OpenHatch newsletter number 17.
Thank you to everyone who helped make open source more welcoming and diverse in 2013! Our blog in December was filled with posts motivating financial support for our Open Source Comes to Campus program in 2014 (and its website got a shiny new redesign). There is still time to donate while it is 2013 somewhere in the world!
- Happy holidays from OpenHatch!
- Congrats to friends of OpenHatch at PyCon 2014!
- Ready, Set, Contribute: a handbook for preparing your open source project for events
- What contributing to open source can give back to you
- How I found an open source project for me (and why to support OpenHatch)
- Open Source Comes to Campus
- Meet Mandar, an OpenHatch contributor!
- Teaching Open Source in Chicago
- Why I care about OpenHatch: changing people’s relationship with software
- Matching your Open Source Comes to Campus donations, starting today
- Support OpenHatch!
New projects in the OpenHatch volunteer opportunity finder
- BountyFunding, a new crowdfunding platform for sponsoring features and bugfixes in open source projects.
- Cubes, a “Python framework and OLAP HTTP server for easy development of reporting applications and aggregate browsing of multi-dimensionally modeled data”.
- GlitterGallery, a way to “share, collect feedback on, and view/manage design iterations” (under development), with a cool comic in its readme to explain the project.
- jsDelivr, a “a free CDN (Content Delivery Network) where any web developer can host their files, including CSS, fonts, JavaScript, jQuery plugins, etc.”
OpenHatchy but not OpenHatch things around the web
Jessica McKellar: “Hello from your @PyCon Diversity Outreach Chair. % PyCon talks by women: (2011: 1%), (2012: 7%), (2013: 15%), (2014: 33%). Outreach works.”
Igor Steinmacher is doing research on problems faced by newcomers to open source software:
I am investigating ways to support new Open Source contributors during their first steps in the project. My final goal is to verify what kind of tooling is appropriate to support the newcomers overcoming their difficulties when they are willing to contribute to the project.
I want to talk to people who experienced problems when onboarding Open Source Software projects. I am interested both in people that faced issues when trying to contribute and could not make it and those who just started their contribution to an Open Source project.
Get in touch with Igor at the link.
Findings from the first Wikimedia train the trainer event in India.
A program that pairs students with open source projects for university credit.
How Harvey Mudd transformed its computer science program and nearly closed its gender gap.
Also check out links submitted to /r/openhatch, and add your finds!
Get involved
You can help write this newsletter! The January newsletter will be edited at htmlpad and may be previewed there as well. Join our publicity list or hop on #openhatch with suggestions and questions.
Thanks to Britta Gustafson for contributing to this edition!
Happy holidays from OpenHatch!
The three-week-long matching period of OpenHatch’s fundraiser ended yesterday. During that time, OpenHatch raised $9801.98 from individual donors! While our anonymous matching challenge funder was initially planning to match up to a cap of $5000, he or she has decided to match all of the funds given to OpenHatch during that period.
That means that thanks to supporters like you donating and getting the word out, we’ve raised almost $20,000 in the last three weeks to support free software community outreach and diversity! That’s more that OpenHatch has ever raised in previous years from individual donors.
Wow. Thank you, so very much. These donations will enable us to continue the Open Source Comes to Campus program in 2014, teaching the next generation how to participate in free, open source software projects.
If you haven’t donated yet to OpenHatch, it’s not too late–our fundraising drive continues until the end of the year. You can make your tax-deductible* donation today at https://openhatch.org/donate/.
From all of us at OpenHatch, I wish you a merry Christmas and hope your holidays are peaceful, snug, and warm.
* In the US; please consult your accountant.
Congrats to friends of OpenHatch at PyCon 2014!
The list of talks, tutorials and posters accepted to PyCon 2014 was announced yesterday. Excitedly, we took to Twitter to congratulate the many OpenHatch community members who had their proposals accepted – only to realize there’s no way they’d all fit in a single tweet! We decided to write a blog post instead.
We’re so honored that the following people have taken time in the past to contribute to OpenHatch, and we’re looking forward to seeing them all at PyCon!
Marina Zhurakhinskaya is giving a talk on the Outreach Program for Women, which she organizes for the GNOME Foundation. Marina has volunteered as a mentor at several Open Source Comes to Campus events, where she always makes sure to mention OPW – even when she can’t come to events, we make sure students know about this opportunity.
Sheila Miguez is presenting a poster on ResearchCompendia, an open source scientific publishing platform she’s helped build as part of her work at Columbia University. Sheila has been a mentor at Open Source Comes to Campus events and can often be found answering questions and sharing resources in our IRC channel.
Sumana Harihareswara is presenting a poster about her experiences at Hacker School and how that’s influenced her work as a community mentor. Sumana works for the Wikimedia Foundation as an engineering community manager, and she’s a dynamic, engaging speaker – her talk about open source at Wellesley College inspired a student to bring us to her campus.
Paul Tagliamonte is giving a talk on Hy, a Lisp front-end for Python. Paul has volunteered at several Open Source Comes to Campus events, and he’s the go-to person for newcomers interested in getting involved in OpenHatch-affiliated project OpenStates. Fun fact: OpenStates, which Paul develops in his work at the Sunlight Foundation, got its start at a PyCon sprint in 2009.
Carol Willing is presenting a poster on Python music tools and their role in education. Carol is a software and hardware developer and mentor; she volunteered with OpenHatch at Grace Hopper Open Source Day, and she has made multiple documentation contributions to OpenHatch.
OpenHatch board member Jessica McKellar is giving multiple talks, including a keynote address, tutorials on getting started in open source and learning to program in Python, and a talk on building a Python sandbox. Jessica also deserves congratulations for her work as chair of PyCon’s diversity outreach, which has more than doubled the number of women speakers from last year.
OpenHatch’s lead designer, Karen Rustad, and OpenHatch co-founder, Asheesh Laroia, are teaming up for a talk on turning your computer into a server. Karen drew most of the graphics you see on the website, has committed code to the main web app, and is active on the OpenHatch board. Asheesh does code review, helps plan events, and is the President of our non-profit.
Catherine Devlin, Ned Batchelder and Naomi Ceder have all run or volunteered at OpenHatch-affiliated events – and they’re all giving talks at PyCon this year! Catherine’s talk on tools that blur the boundaries between code and documentation and Ned’s talk on writing Python tests look like great choices for attendees focused on usability. Naomi’s talk on her experience transitioning while staying involved in the Python community seems like a great choice for, well, everybody.
Congrats to Portia Burton, Nathan Yergler, and Marta Maria Casetti as well! Portia is giving a talk on making a predictive app using Scikit, while Nathan is giving a talk on Python debugging and Martia is presenting a poster on resources for learning Python. All three of them have contributed to OpenHatch through sprints, including last year’s PyCon sprint. We had so much fun with them, and others, that we’ll be sprinting again at PyCon 2014.
Volunteer event organizers and mentors Alex Gaynor, Emily Chen and Akkana Peck, who’ve shared their skills and wisdom with our students, will be spreading the knowledge at PyCon this year. Alex is giving a talk on understanding and implementing Pickle, a Python module for object serialization, while Emily is presenting a poster on using machine learning to analyze tweets about fashion brands, and Akkana is leading a tutorial on home automation. Board observer Selena Deckelmann is giving a talk on doing Python outreach to K-12 educators, while friend and contributor Christine Spang is giving a talk on wrapping C libraries for Python and a tutorial on information retrieval. Contributor Jean-François Fortin Tam is presenting a talk on PiTiVi, a video editor, while contributor Susan Tan is giving a talk on Python in the browser.
What a great set of talks, tutorials, and posters! We’re looking forward to seeing as many of these as we can. If you can’t wait until PyCon to learn from these folks, try following them all on Twitter.
Did we miss anybody? Get any names, facts, or attributions wrong? Let us know and we’ll fix it.
These are just the people who have talks in the PyCon program. There will be lots of other OpenHatch community members attending PyCon – including myself. See you all in April!
Ready, Set, Contribute: a handbook for preparing your open source project for events
Today, we’re releasing a handbook to help open source projects prepare themselves for events.
Here’s why: over the last year of Open Source Comes to Campus, we’ve given more than two hundred people the tools and the opportunity to contribute to open source projects. But not every student is able to submit a patch or pull request. The biggest obstacle by far? Confusing documentation and poorly defined tasks in the projects they’re trying to contribute to.
A group of students at our Purdue event faced this obstacle. They spent all afternoon trying to address a bug in Privly. Their description of the problems they encountered: “lots of downloads, need an approved account to have access… had to create own database on localhost… tears clouding vision”. Although they were good-humored about it (see the picture above), they never were able to work on the task they’d picked.
At OpenHatch events, we’ve adapted to this common roadblock by requiring that the projects we present to students do a few things, including testing their installation instructions, identifying good tasks to work on, and being available during some of our events. We call these OH-affiliated projects. Putting these benchmarks in place has helped us increase the number of contributions at events, and decrease the frustration. We’d recommend that any event organizer ask the same of participating projects – especially if their event is geared towards newcomers.
To help open source projects prepare themselves for events, we’ve written a handbook aimed at making projects easier to understand, install, and contribute to:
It’s a short, practical list of steps to you can take to improve the odds that newcomers will be able to contribute to your project at a hackathon, workshop or sprint. For each recommendation, we’ve included an example of implementation from our own project: OpenHatch.
The guide is, itself, an open source project (licensed CC BY). We welcome your feedback and contributions: you can share advice and submit changes via email, the issue tracker, or by submitting a pull request on Github. You can fork the guide as well.
We hope you find this helpful, and that it increases the number of successful contributions – and the number of happy contributors – to your project.
You can learn more about what OpenHatch has been working on (and support it with a donation) on our 2014 fundraising page.