Code Monkey home page Code Monkey logo

oss-workflow's Introduction

Open Source Workflow

Third Party Contribution

You are encouraged to contribute to third party repositories during your work time:

  • The subject must be related to a problem of your project or work
  • Your manager must be notified

Open Source A Library Or An Application

Workflow to follow in order to Open Source a library or an application.

Why a workflow

This workflow help to align all the actors of an entity on the same objectives.

whithout a workflow : Why a workflow

with a workflow : Why a workflow

1) Prerequisites

Please consider to be Open Source First:

  • More feedbacks
  • Iterate quicker (open source does not mean to be perfect, but on the way to be perfect quicker)

Prerequisites for starting a new pure technical asset "Open Source First"

  • No business rule specific to AXA
  • License (MIT / Apache v2)
  • Mandatory files : README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE.md, CHANGELOG.md, Templates : Issues, PR
  • At least one “Repository Maintainer“

Prerequisites for an existing internal technical asset

  • No business rule specific to AXA
  • Code quality & practices
    • At least 60% of code coverage
  • CI (Continuous Integration) with all the internal tools
  • License: MIT
    • please note that you have to "Copy/Paste" the licence text because it has to specify the entity "AXA France IARD / AXA France VIE"
  • Mandatory files : README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE.md, CHANGELOG.md, Templates : Issues, PR
  • At least one “Repository Maintainer“

Workflow step 1

2) Validations

  • Technical director of the entity
  • Security validation

Workflow step 2

3) Team/Maintainer Must

  • Use and force two factor Authentication everywhere it is possible: github, npm, nuget, etc.
  • Tokens must be kept private
  • Set up and maintain CI / CD
  • Manage the roadmap
  • Manage “Issues” and “PullRequests”
  • Help to grow the community

Workflow step 3

4) Mentality

  • Going Open Source brings and requires a change of mentality within development teams.

Workflow step 4

oss-workflow's People

Contributors

antoineblancke avatar g7ed6e avatar gcruchon avatar guillaume-chervet avatar jlou avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.