Open Source Spree
The focus of Scala Sprees is to introduce newcomers and veterans alike to open source! Come meet contributors of well-known open source Scala projects and learn how you can make your own contribution.
Scala Wave 2018 (Gdańsk, Poland) September 9th
|Time||September 9th, 9:00am - 4:00pm|
|Location||Olivia Business Centre, Olivia FOUR, aleja Grunwaldzka 472a|
|Conference registration||Not Required|
|Event Registration||Free, required: event-registration|
|Food||Free: Sponsored by Scalac|
|Bring||Laptop + Power Cord|
|Presenting the projects||9:30am|
|Dinner & Networking||1:00pm|
Projects (Maintainers: Please add your project here!)
Here is a list of projects that you could contribute to during the spree:
|Chimney - Scala library for boilerplate-free data transformations||@krzemin|
|julienrf/endpoints - API definition shared between client, server and docs (issues)||@Krever|
|Bloop - Scala build server||@tues|
|Add your project here!|
Who will be leading the Scala Open Source Spree?
- Darja Jovanovic, [@darjutak] (Scala Center)
Want to add your project to the list? Jump to the next section!
Duration, pace steps
At the beginning, maintainers gather together in front of all the contributors to briefly explain their projects and tickets in one minute. The idea is to give a good high-level explanation to motivate participants without going into too much detail. A link to this page is provided.
When they are done, participants approach the projects they are most interested in and get it contact with the maintainers. At this point, maintainers usually listen to the participants' experience and provide personal guidance on tickets that would suit them.
Then, the fun begins! Participants start hacking on their projects and maintainers review PRs as they come, assisting participants when they ask for help. We encourage maintainers to merge as many PRs as possible in the place, for two reasons:
- Participants get a small token of appreciation from the Scala Center.
- It increases the motivation of the participants.
If participants get the first PR merged, they are invited to continue solving issues until they are happy with their work!
At the middle of the spree, the Scala Center and sponsors of the event provide maintainers and participants alike with some refreshment (drinks, sandwiches, pizza, etc).
Participants can leave the event at any time they want. When the time approaches the end, everyone starts to wrap up: participants finish their PRs while maintainers finish their review, and organizers of the spree give away Scala t-shirts. We finish by thanking your hard work for open-source.
How to propose a project
A Scala Center spree is the perfect event to gauge interest in your open-source projects. You not only have the opportunity to get new contributors involved in your project, but you can win friends and lifetime maintainers that help you make a difference in the open-source world.
There is only one requirement to submit a project -- you need to be present for the duration of the Scala Center spree. Your physical presence is important to assist and motivate contributors.
If you are a maintainer of an open-source Scala project, make a PR to add your project to the list!
What you need to do
Create a PR with the following information:
- Project information.
- Your contact details.
- A link to a "spree" or "hackathon" label with curated tickets for the participants. See this project for inspiration.
It's important that the curated tickets are entry-level, typical issues that you would solve in 15-20 minutes of your time as an experienced maintainer. In our experience, newcomers will take 1 to 2 hours to address them, assuming they are unfamiliar with the codebase and this is their first contribution.
How to be an effective maintainer
Maintainers can make a difference by tweaking some knobs:
- Provide a
CONTRIBUTINGguide. Contributing guides explain to newcomers the usual workflow to get started and what's expected from them. Good guides: scala/scala, sbt/zinc, scalameta/scalameta, scalacenter/scalafix.
- Provide a motivating
READMEwith clear instructions. Make sure docs are up to date.
- Link to documentation when possible, or show contributors how to search for
docs. You can label as
docsany issue or PR with relevant discussions to get acquainted with implementation details and design decisions.
- Be nice to newcomers, they will always remember it!
How to write good tickets
Curating tickets is not easy. If you want to optimize for the highest number of contributors, we recommend you to:
- Give hints on potential solutions. Say which solutions are not on the table, if any.
- Describe the purpose of the ticket and its context. Having a clear idea of why your ticket is relevant will motivate participants.
- Add links to source code sparingly. Show the entry-points for the requested functionality / fix, give a basic explanation of the code structure.
- Be concise and detail specifics of your project or its implementation. Providing this kind of domain knowledge to participants will help them finish off their tickets sooner, and move to the next one!