loading . . . How to help an Open Source project that your company depends on <p>I'm in touch with a company that is trying to figure out how to best
help specific Open Source projects that they depend on
(i.e. it is part of their <a href="https://en.wikipedia.org/wiki/Software_supply_chain">SBOM</a>).
I'll do something unusual for me today, and do a public braindumb on the topic,
and adjust these notes over time. Let's dive right in:</p>
<h2>Why help Open Source in the first place?</h2>
<p>Benefits of helping the Open Source projects that you depend on include that:</p>
<ul>
<li>your software dependency is more likely to stay in good enough shape to
fix vulnerabilities and release security fixes with little delay,
and hence increase your own products security</li>
<li>you avoid a "riding a dead horse" situation without knowing</li>
<li>you get organic marketing (brand visibility, value signaling,
attention from potential hires, ..)</li>
<li>you get a feel of being part of the solution</li>
<li>you build relationships for the future</li>
</ul>
<h2>What state does the project need to be in to be considered healthy?</h2>
<p>Project health has many aspects, some less obvious, in particular
to non-developers. All aspects of project help offer unique opportunities
to be helpful.</p>
<p>To be a healthy dependency, you want the following future state for the
project (in no particular order):</p>
<ul>
<li>maintainable and secure code,</li>
<li>maintainable build system,</li>
<li>tests and good test coverage (to avoid bugs and regressions),</li>
<li>secure CI pipeline running the tests (to avoid regression),</li>
<li>static analysis in CI (to reduce introduction of bugs),</li>
<li>runtime analysis (to reduce introduction of bugs) e.g. use of ASan and UBSan with C/C++ projects,</li>
<li>code auto-formatting and checks for formatting violations in CI (for readability, morale, efficiency of review),</li>
<li>support for recent toolchains (e.g. recent compilers, for agility and morale),</li>
<li>(<em>no</em> support for ancient toolchains (for agility and morale),)</li>
<li>an all-warnings-addressed situation
(e.g. using <code>-Werror -Wno-error=...</code> in CI (but not in packaging) for C/C++ code)
or actively working towards reducing the list of explicit exclusions
for all static analysis tools in use,</li>
<li>collaborative attitude among project contributors,</li>
<li>low number of stuck issues (for morale and efficiency),</li>
<li>low number of stuck pull requests (for morale and efficiency),</li>
<li>timely, thorough, co-operative code review for pull requests (for morale and progress),</li>
<li>timely and co-operative responses, analysis, discussion in issues (for morale and progress),</li>
<li>integrated use of fuzzing (to detect unknown vulnerabilities)
with good fuzzing code coverage (upstream and/or in OSS-Fuzz).</li>
</ul>
<h2>How to fund help in general?</h2>
<p>There are multiple options:</p>
<ul>
<li>a) pay existing hands upstream (through funding or employment)
that are open to direct funding</li>
<li>b) bring new hands that you already pay for
(e.g. through ongoing employment)</li>
<li>c) bring new hands that you will pay for</li>
<li>d) combinations of (a), (b) and/or (c)</li>
<li>e) pay a third party to organize (d) for you well</li>
</ul>
<p>Every project is unique in the needs: some maintainers are happy to
spend more of their own time for compensation, others are already
at their limit of spending time, need self-organizing additional hands,
have no use for payment at all, and so on.
Finding the approach that works for a specific project through discussion
is key.</p>
<h2>What are the challenges in funding a project?</h2>
<ol>
<li>Paying contributors can get them into situations of conflict of interests.</li>
<li>Paying contributors can create an atmosphere of envy and injustice.</li>
<li>Paying contributors can become tricky legally when they work on the project
during both work hours and spare time, e.g. with regard to legal maximum de-facto work hours per day.</li>
<li>Paying existing contributors can affect their motivation to work on the project for better or worse.</li>
<li>Paying existing contributors on project A can make them neglect other important duties, e.g. work on project B.</li>
<li>Producing more non-trivial pull requests takes away time from existing contributors (and can hence hurt more than help).</li>
<li>Some contributors like to avoid voice/video calls and some like to avoid text ping-pong,
i.e. individual needs need individual approaches.</li>
</ol>
<h2>What can be done about these challenges?</h2>
<p>Some ideas about how to tackle these challenges:</p>
<ul>
<li>For (1) communicate (and mean) that you understand and expect that their conscience,
ethical behavior and the community interests of the project are at least as important as your business interest.</li>
<li>For (2) consider approaching the whole project on the topic of funded contributions before starting to fund.</li>
<li>For (3) discuss the issue with funded contributors upfront.</li>
<li>For (4) discuss the topic with funded contributors upfront, to get a sense for the kind of affect you would have.</li>
<li>For (5) discuss their situation in life and other duties with them before funding.</li>
<li>For (6) discuss with existing contributors:<ul>
<li>how to maximize pull requests for reviewability to their eyes,</li>
<li>how much volume or pace of contribution they can sustainably handle at the moment,</li>
<li>whether voice/video calls or text ping-pong fits there individual needs better,
and</li>
<li>which issues (or types of issues) to start helping with and which issues to not touch at the moment.</li>
</ul>
</li>
<li>For (7) discuss with existing contributors.</li>
</ul>
<h2>Take home points</h2>
<ul>
<li>It can be done.</li>
<li>Every project has different needs.</li>
<li>There is plenty of things that projects need help with.</li>
<li>You have a unique profile what kind of help fits you best.</li>
<li>You can <a href="https://blog.hartwork.org/posts/how-to-help-open-source/">bookmark this page</a> so you find your back here easily later.</li>
</ul>
<p>Did any of that hit a nerve with you or made no sense at all?<br/><a href="mailto:[email protected]">Let me know</a> and have a nice day!</p> https://blog.hartwork.org/posts/how-to-help-open-source/
