Boost
your opensource project
Christopher MANEU
Azure Engineer & Advocate @ Microsoft R&D
@cmaneu (with a little help from @juliendubois)
Slide 2
Slide 2 text
@cmaneu
I won’t talk about
Why you may want to opensource something?
How you can become rich with opensource?
How you can become famous with opensource?
Slide 3
Slide 3 text
@cmaneu
Boost , but what?
Your users The maintainers
The contributors
Slide 4
Slide 4 text
@cmaneu
Boost , but what?
Your users The maintainers
The contributors
Understand the OSS Funnel
aka.ms/boost-oss/funnel
Slide 5
Slide 5 text
@cmaneu
chris@Azure:~$
# Attract users to your project
# Simplify contributions
cat boost-my-oss-project.md
Slide 6
Slide 6 text
@cmaneu
chris@Azure:~$
# Attract users to your project
# Simplify contributions
cat boost-my-oss-project.md
Slide 7
Slide 7 text
@cmaneu
Slide 8
Slide 8 text
@cmaneu aka.ms/boost-oss/readme
Slide 9
Slide 9 text
@cmaneu
Readme good practices
Have a logo and a
clear description
of your project
Show your
project: Gif, Video,
Screenshots
Give a way to
quickly start using
your project
Slide 10
Slide 10 text
@cmaneu
Have a great documentation
Slide 11
Slide 11 text
@cmaneu
Use multiple communication channels
Project updates
New releases
Thanks contributors
Project announcement
Big releases
Getting started
Tutorials
Architecture/code challenges
Slide 12
Slide 12 text
@cmaneu
chris@Azure:~$
# Attract users to your project
## Create a great readme.md
## Spend some time creating a documentation
## Get a _getting started_
## Use several communication channels
# Simplify contributions
cat boost-my-oss-project.md
Slide 13
Slide 13 text
@cmaneu
chris@Azure:~$
# Attract users to your project
## Create a great readme.md
## Spend some time creating a documentation
## Get a _getting started_
## Use several communication channels
# Simplify contributions
cat boost-my-oss-project.md
@cmaneu
Create a contributing.md
• Coding conventions
• Styleguides
• Reporting bug/features
• Definition of done
• Testing
• Pull requests rules
• How to ask questions
Slide 22
Slide 22 text
@cmaneu
Slide 23
Slide 23 text
@cmaneu
Have some
Slide 24
Slide 24 text
@cmaneu
Get a dev environment in seconds VS Code
aka.ms/boost-oss/vscode-remote
Slide 25
Slide 25 text
@cmaneu
Automate your builds & releases
Azure Pipelines
Free unlimited build minutes for
public projects
Up to 10 free parallel jobs across
Windows, Linux and macOS
aka.ms/boost-oss/pipelines
aka.ms/boost-oss/learn-pipelines
Slide 26
Slide 26 text
@cmaneu
Automate your dependency updates
Dependabot
Check for updates
Opens pull requests with fixes.
Works with npm, pip, composer,
docker images, nuget, …
Free
aka.ms/boost-oss/dependabot
@cmaneu
chris@Azure:~$
# Attract users to your project
# Simplify contributions
## Work on developer documentation
## Have simple tasks for new contributors
## Simplify dev environment setup with VS Code Remote Extensions
## Get automated builds & tests with Azure Pipelines
## Automate dependency updates with Dependabot
cat boost-my-oss-project.md
Slide 29
Slide 29 text
Thanks !
Christopher MANEU
Azure Engineer & Advocate @ Microsoft R&D
@cmaneu
aka.ms/boost-oss/slides