Skip to content

Commit

Permalink
docs(guidelines): add guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
clementgig committed Oct 9, 2024
1 parent 6f9c3ff commit 930a6ff
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# Open Source Workflow

- [Third Party Contribution](#third-party-contribution)
- [Open Source A Library Or An Application](#Open-Source-A-Library-Or-An-Application)
- [Open Source A Library Or An Application](#open-source-a-library-or-an-application)

## 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

Expand All @@ -26,13 +27,14 @@ with 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"
### Prerequisites for starting a new pure technical asset "Open Source First" or public activity material (workshops, talks, resources for blog post)

- No business rule specific to AXA
- License ([MIT](https://github.com/AxaGuilDEv/react-oidc/blob/master/LICENSE) / Apache v2)
- License ([MIT](https://github.com/AxaFrance/react-oidc/blob/master/LICENSE) / Apache v2)
- Mandatory files : README.md, CONTRIBUTING.md, CODE_OF_CONDUCT.md, LICENSE.md, CHANGELOG.md, Templates : Issues, PR
- At least one “Repository Maintainer“

Expand All @@ -42,12 +44,11 @@ Please consider to be **Open Source First**:
- 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)
- License: [MIT](https://github.com/AxaFrance/react-oidc/blob/master/LICENSE)
- 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](./images/workflow-step1.png)

## 2) Validations
Expand All @@ -59,11 +60,25 @@ Please consider to be **Open Source First**:

## 3) Team/Maintainer Must

- Use and force two factor Authentication everywhere it is possible: github, npm, nuget, etc.
- Tokens must be kept private
Checklist for repository creation:

- Write a repository description
- Add `axa` topic and some of following topics that match those referenced on our GitHub organization page (`data`, `ai`, `ml`, `green`, `test-automation`, `security`, `tools-engineering`, `raise-the-bar`, `front-end-development`, `csharp`, `dotnet`, `java`, `python`)
- Consider adding a social media preview

Checklist to set up contributions management:

- Set up protection rules on the `main` branch with code review enforcement
- Use commit signature verification using your @axa.fr email on GitHub ([see documentation](https://docs.github.com/authentication/managing-commit-signature-verification/about-commit-signature-verification))
- Use and enforce two-factor authentication everywhere it is possible: GitHub, npm, nuget, etc.
- Set up and maintain CI / CD
- use Github Action
- use GitHub Action
- use https://sonarcloud.io/organizations/axaguildev
- Consider configuring code owners ([see documentation](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners))

Follow these guidelines for all contributions:

- Keep tokens, secrets and certificates private
- Manage the roadmap
- Manage “Issues” and “PullRequests”
- Help to grow the community
Expand All @@ -75,3 +90,10 @@ Please consider to be **Open Source First**:
- Going Open Source brings and requires a change of mentality within development teams.

![Workflow step 4](./images/workflow-step4.png)

## 5) Repository end of life

When the asset becomes deprecated and unused, the repository will no longer be updated.

- Archive the repository
- If necessary, change the visibility to private

0 comments on commit 930a6ff

Please sign in to comment.