Dev Days 2023
Hello, and welcome to ASWF Dev Days!
The ASWF is organizing an event called "Dev Days," which is kind of a hackathon with the goal of getting a bunch of people who haven't contributed to these projects (or maybe any open source project) to pick a "1-day" task and make their first contribution. It's scheduled for October 12-13, 2023 (you pick whichever day or time split is convenient to you). During that time, the senior developers of the project will be monitoring the mail list, Slack, and GitHub, standing by to answer questions and help you through the process.
Check out the ASWF Dev Days site and the participating projects, and if you are interested in participating, please register! If you have questions, please reach out, or join the #devdays slack channel on the ASWF Slack instance.
If you're reading this, you're probably interested in contributing to OpenImageIO. So also say hi on our Slack or mail list, introduce yourself, and let us know what you'd like to work on (or ask for advice on what to work on).
Here's how I explained it to people in my own company:
I really can't emphasize enough how much participation in these open source projects can be an enriching professional experience: becoming more knowledgeable about, contributing to, and steering technologies that are critical to us and the industry as a whole, while collaborating with, learning from, and having your work seen and acknowledged by your peers at other studios. This event is a low-stakes way to dip your toes into any of these projects for a day.
This is for you to get something out of, but it's also for us as a company. These projects are not just fun, do-gooder tasks. Almost every one is a critical technology underlying our tools and productions. Sometimes, though, we may have only one person who is knowledgeable about the internals and feels comfortable fixing or enhancing these projects, and that's a risk given how important they are. So it's helpful for us to have multiple people who feel like they can jump in and make changes needed.
- Check out https://sites.google.com/view/aswfdevdays/home, they have a form to sign up.
- Choose a project (probably OIIO if you're reading this here) that you'd like to learn more about by working on for a day.
- If you're doing this at work, arrange with your supervisor to get the time on those days to work on it, duh, and also your company may need to do some advance work to ensure you have permissions to work on the project, get CLAs signed, etc. Just check with whoever seems to be experienced with open source at your company to have them tell you what, if anything, you need to do. If you are a student or independent, or know for sure that things you work on in open source are your own, then you can skip this step.
- Between now and Oct 12, figure out how to check out and build the project so you aren't fumbling with that for the first time on the work day.
- Choose a task. See below.
Ideally, you want to choose a task that's big enough that you'll learn something and that will be helpful to the project, but small enough that you can probably complete it in one day. Hard enough to stretch you, easy enough to leave you excited and wanting more.
On our Issues Page, we try to mark things of this size -- maybe a one-day task for somebody who is new to the project -- with a tag called "good first issue."
Let's suggest a couple that are evergreen, meaning that the issue describes a general task that needs to be done in many places, each of which can be a one-day task, so multiple people may select the same task (as long as they coordinate enough to know they are all choosing separate instances of the task that need to be performed).
-
Add check_open validity plausibiity checks to format readers
The task here is to add a validity check to one of the image file format reader. When the file is first opened, you're checking its resolution, number of channels, memory size, and so on, to see if it's plausible. If so, you proceed. But if not, you think maybe this is a corrupted or malicious file, and consider it an error so you don't get into bigger trouble by trying to read the whole file. There are one or two examples of formats where we've done this check. You just need to add a similar check to one or more additional formats.
This task is actually quite small -- so maybe if you find it goes very quickly, you'll want to extend your task to do it for multiple formats. Or maybe good to choose if you're not fully comfortable in C++ or building software yet. Or if you don't have a whole day, you just have a couple hours.
-
Turning documentation examples into tests
We have a detailed explanation on our Wiki.
Basically, the task is to take a code example from the documentation, and turn it into a testsuite entry, debugging/fixing if necessary (then changing the docs to just include the test by reference, so it's not duplicated). The point here is:
- Make sure most of the code in the docs is tested, and works for sure, and by being incorporated into the testsuite, can never become "obsolete" (for example, by the APIs changing but the examples in the docs docs don't change to match).
- Beef up the testsuite with more examples, better code coverage in the tests -- without having to write new tests from scratch, but merely take code already existing in the docs.
-
Something else that you pick
Does it have to be something we suggest above? No.
Does it have to be something we marked as "good first issue?" No.
Can it be something that's not a currently filed issue at all? Yes!
Can it be something that you have a particular interest in, because it's related to how you or your company use OpenImageIO? YES YES YES! This would be the ideal case.