From aefcab63c85dd315ec036a649c36f06d4ac92b00 Mon Sep 17 00:00:00 2001 From: soprop Date: Tue, 27 Aug 2024 10:01:57 +0000 Subject: [PATCH] new page Common + PR rules --- docs/common.md | 5 +++++ docs/common/pull-request.md | 10 ++++++++++ docs/js.md | 4 +--- docs/php.md | 6 ++---- docusaurus.config.js | 12 +++++++++--- sidebars.js | 1 + src/pages/index.js | 10 ++++++++++ 7 files changed, 38 insertions(+), 10 deletions(-) create mode 100644 docs/common.md create mode 100644 docs/common/pull-request.md diff --git a/docs/common.md b/docs/common.md new file mode 100644 index 0000000..6affea7 --- /dev/null +++ b/docs/common.md @@ -0,0 +1,5 @@ +--- +title: 'Bonne pratiques générales' +--- + +[Pull request](./pull-request) diff --git a/docs/common/pull-request.md b/docs/common/pull-request.md new file mode 100644 index 0000000..56673d6 --- /dev/null +++ b/docs/common/pull-request.md @@ -0,0 +1,10 @@ +--- +title: 'Pull request' +--- + +Une pull request doit respecter les règles suivantes avant d'être mergée : + +- 2 reviewers minimum (cas exceptionnel : pompier urgent ou upgrade de package) sans contrainte de durée +- Favoriser les PR de - de 1000 lignes (avec tests) / 600 lignes de code pur + +NB : en cas d'absence de review, c'est à l'auteur de la PR de relancer. Si l'équipe concernée ne review pas la PR rapidement, le remonter au point tech en rappelant la responsabilité collective de la review. diff --git a/docs/js.md b/docs/js.md index 22e9574..564f5ce 100644 --- a/docs/js.md +++ b/docs/js.md @@ -1,9 +1,7 @@ --- -title: 'Bonnes pratiques à Mapado' +title: 'Bonnes pratiques JS' --- -Voici une liste de nos bonnes pratiques - [Guide de style](./style) [React](./react) diff --git a/docs/php.md b/docs/php.md index fd41559..653c94d 100644 --- a/docs/php.md +++ b/docs/php.md @@ -1,11 +1,9 @@ --- -title: 'Mapado Best practices for PHP' +title: 'Bonnes pratiques PHP' --- -Here is a list of our best practices - [PHP](./php) [Symfony](./symfony) -[API-Platform](./api-platform) \ No newline at end of file +[API-Platform](./api-platform) diff --git a/docusaurus.config.js b/docusaurus.config.js index c218e4a..ea531ba 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,6 +1,6 @@ module.exports = { - title: 'best-practice', - tagline: "Mapado's developer best practices", + title: 'Bonnes pratiques de Mapado', + tagline: "Comment être un bon développeur chez Mapado", url: 'https://mapado.github.io/', baseUrl: '/best-practices/', favicon: 'img/favicon.ico', @@ -8,12 +8,18 @@ module.exports = { projectName: 'best-practices', // Usually your repo name. themeConfig: { navbar: { - title: 'Mapado best practices', + title: 'Bonnes pratiques', logo: { alt: 'Mapado', src: 'img/logo.png', }, links: [ + { + to: 'docs/common/', + activeBasePath: 'docs/common/', + label: 'Général', + position: 'left', + }, { to: 'docs/js/', activeBasePath: 'docs/js/', diff --git a/sidebars.js b/sidebars.js index 668a2cc..a9abdca 100644 --- a/sidebars.js +++ b/sidebars.js @@ -9,4 +9,5 @@ module.exports = { 'js/testing', ], php: ['php', 'php/php', 'php/symfony', 'php/api-plaform'], + common: ['common', 'common/pull-request'], }; diff --git a/src/pages/index.js b/src/pages/index.js index ee66858..96a85ed 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -67,6 +67,16 @@ function Home() {

{siteConfig.title}

{siteConfig.tagline}

+ + Général + +