Skip to content

Commit

Permalink
docs(workflow): first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
guillaume-chervet committed Sep 14, 2020
0 parents commit ce4f63d
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@

# Open Source Workflow

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 worflow](./images/why-workflow-1.png)

with a workflow :
![Why a worflow](./images/why-workflow-2.png)

# 1) Prerequisites

- 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](https://github.com/AxaGuilDEv/react-oidc/blob/master/LICENSE) / Apache v2)
- Mandatory files : README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENCE.md, CHANGELOG.md, Templates : Issues, PR
- At least one “Repository Maintainer“

![Worflow step 1](./images/workflow-step1.png)

# 2) Validations

- Technical director of the entity
- Communities of practice:
- Security
- Software Craftmanship

![Worflow step 2](./images/workflow-step2.png)

# 3) Team/Maintainer Must

- Use and force two factor Authentication everywhere it is possible: github, npm, nuget, etc.
- Tokens must be keeped private
- Set up and maintain CI / CD
- use https://dev.azure.com/axaguildev
- use https://sonarcloud.io/organizations/axaguildev
- Manage the roadmap
- Manage “Issues” and “PullRequests”
- Help to grow the community

![Worflow step 3](./images/workflow-step3.png)

# 4) Mentality

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

![Worflow step 4](./images/workflow-step4.png)
Binary file added images/why-workflow-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/why-workflow-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/workflow-step1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/workflow-step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/workflow-step3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/workflow-step4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ce4f63d

Please sign in to comment.