The document discusses best practices for creating, growing, and maintaining an open source community. It covers topics such as code structure, licensing, hosting, communication channels, release cycles, and sustainability. The key messages are to follow your goals for the project, adapt processes and tools as needed, consider contributors' health and well-being to avoid burnout, and promote the project through various channels.
1 of 52
Download to read offline
More Related Content
Creando, creciendo, y manteniendo una comunidad de codigo abierto
7. @aalmiray | andresalmiray.com
Easy Steps
• Star/favorite the code repository.
• Join the mailing list (if any) to ask questions, fallback to
issue tracker.
• File a ticket when encountering an error or potential bug.
21. @aalmiray | andresalmiray.com
Licenses
• Choose a license (or licenses) that match your goals:
• Mind liabilities clause(s)
• Is commercial usage allowed?
• Do you care about patents?
• When unsure consult with developers of a project you
think has similar goals as yours.
27. @aalmiray | andresalmiray.com
Build
• Pick the one you’re more familiar with.
• Don’t be afraid to experiment with other tools if needed.
• Be careful if choosing the next hyped tool.
• Avoid IDE speci
fi
c setup as much as possible.
• Fail fast, report early.
28. @aalmiray | andresalmiray.com
Build
• Document build and install instructions.
• Document additional environment setup as needed.
• As much as possible, keep the build instructions short,
simple, and executable via command line.
33. @aalmiray | andresalmiray.com
Communication
• Keep it open. Keep it civil.
• Expect interactions with non-native speakers.
• Cultural di
ff
erences are likely to happen.
• Be patient.
37. @aalmiray | andresalmiray.com
Health
• Is the build green or is it broken? Badge it!
• Does code coverage matter? Report it!
• Download numbers.
• Ratio of open/closed tickets.
• Compliance with standards.
40. @aalmiray | andresalmiray.com
Release Cycle
• Pick a release schedule and stick to it until you need a
change.
• Release every X weeks/months.
• Release when big features are ready.
• Release on every feature/bug
fi
x.
• Some other release constraints.
42. @aalmiray | andresalmiray.com
Promotion
• Consider giving a talk at your local User Group.
• Brown bag sessions at your company (when applicable).
• Tweet, tweet, tweet.
• Join hacking events.
45. @aalmiray | andresalmiray.com
Sustainability
• Ask your employer for support (time).
• Consider sponsorship programs (Github Sponsors, Open
Collective, Patreon, etc).
• Create your own company.
46. @aalmiray | andresalmiray.com
Sustainability
• Remember your goals:
• Doing it for fun.
• Scratching your own itch.
• Providing an alternate option to X.
• Starting your own business.
• …
48. @aalmiray | andresalmiray.com
Take care of yourself
• Producing Open Source is a life style choice.
• Rely on teammates.
• Learn to delegate.
• A 7 day commit streak every week is not for everyone nor
should it be a goal in itself.
• It’s OK to break away from a project for a time (or forever).
Don’t let the project guilt trip you into staying.