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

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.

F6c06223e3759e7b9c93bdb58fc241f5?s=128

Christopher MANEU

November 06, 2019
Tweet

Transcript

  1. 1.

    Boost your opensource project Christopher MANEU Azure Engineer & Advocate

    @ Microsoft R&D @cmaneu (with a little help from @juliendubois)
  2. 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?
  3. 4.

    @cmaneu Boost , but what? Your users The maintainers The

    contributors Understand the OSS Funnel aka.ms/boost-oss/funnel
  4. 5.

    @cmaneu chris@Azure:~$ # Attract users to your project # Simplify

    contributions cat boost-my-oss-project.md
  5. 6.

    @cmaneu chris@Azure:~$ # Attract users to your project # Simplify

    contributions cat boost-my-oss-project.md
  6. 7.
  7. 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
  8. 11.

    @cmaneu Use multiple communication channels Project updates New releases Thanks

    contributors Project announcement Big releases Getting started Tutorials Architecture/code challenges
  9. 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
  10. 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
  11. 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
  12. 16.
  13. 17.
  14. 18.
  15. 19.
  16. 20.
  17. 21.

    @cmaneu Create a contributing.md • Coding conventions • Styleguides •

    Reporting bug/features • Definition of done • Testing • Pull requests rules • How to ask questions
  18. 22.
  19. 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
  20. 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
  21. 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