DevFest Strasbourg 19 - BOOSTER VOTRE PROJET OPENSOURCE EN MOINS DE 15 MINUTES

Vous avez publiés un projet OpenSource, c'est bien ! Mais avoir un projet opensource vivant nécessite un peu plus d'effort. Durant ce quickie, nous verrons comment créer la documentation minimum en quelques minutes, ajouter une build et vos test dans vos pull requets, protéger la qualité de vos releases et même financer votre projet opensource.

Transcript

1. Boost
   your opensource project
   Christopher MANEU
   Azure Engineer & Advocate @ Microsoft R&D
   @cmaneu (with a little help from @juliendubois)
   

   View Slide

2. @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?
   

   View Slide

3. @cmaneu
   Boost , but what?
   Your users The maintainers
   The contributors
   

   View Slide

4. @cmaneu
   Boost , but what?
   Your users The maintainers
   The contributors
   Understand the OSS Funnel
   aka.ms/boost-oss/funnel
   

   View Slide

5. @cmaneu
   chris@Azure:~$
   # Attract users to your project
   # Simplify contributions
   cat boost-my-oss-project.md
   

   View Slide

6. @cmaneu
   chris@Azure:~$
   # Attract users to your project
   # Simplify contributions
   cat boost-my-oss-project.md
   

   View Slide

7. @cmaneu
   

   View Slide

8. @cmaneu aka.ms/boost-oss/readme
   

   View Slide

9. @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
   

   View Slide

10. @cmaneu
    Have a great documentation
    

    View Slide

11. @cmaneu
    Use multiple communication channels
    Project updates
    New releases
    Thanks contributors
    Project announcement
    Big releases
    Getting started
    Tutorials
    Architecture/code challenges
    

    View Slide

12. @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
    

    View Slide

13. @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
    

    View Slide

14. @cmaneu
    What’s stopping contributions ?
    

    View Slide

15. @cmaneu
    Documentation 101
    ❑ LICENSE.md
    ❑ README.md
    ❑ CONTRIBUTING.md
    ❑ CODE_OF_CONDUCT.md
    ❑ Issue Templates
    ❑ Pull request templates
    https://github.com/todogroup/repolinter
    aka.ms/boost-oss/readme
    

    View Slide

16. @cmaneu
    

    View Slide

17. @cmaneu
    

    View Slide

18. @cmaneu
    

    View Slide

19. @cmaneu
    

    View Slide

20. @cmaneu
    

    View Slide

21. @cmaneu
    Create a contributing.md
    • Coding conventions
    • Styleguides
    • Reporting bug/features
    • Definition of done
    • Testing
    • Pull requests rules
    • How to ask questions
    

    View Slide

22. @cmaneu
    

    View Slide

23. @cmaneu
    Have some
    

    View Slide

24. @cmaneu
    Get a dev environment in seconds VS Code
    aka.ms/boost-oss/vscode-remote
    

    View Slide

25. @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
    

    View Slide

26. @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
    

    View Slide

27. @cmaneu
    Automate pull request lifecycle
    Slack reminders
    Intelligent assignment
    Analytics
    Free
    Pull Panda
    

    View Slide

28. @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
    

    View Slide

29. Thanks !
    Christopher MANEU
    Azure Engineer & Advocate @ Microsoft R&D
    @cmaneu
    aka.ms/boost-oss/slides
    

    View Slide