Skip to content

Commit

Permalink
new page Common + PR rules
Browse files Browse the repository at this point in the history
  • Loading branch information
SopRop committed Aug 29, 2024
1 parent cdb8aee commit aefcab6
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 10 deletions.
5 changes: 5 additions & 0 deletions docs/common.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: 'Bonne pratiques générales'
---

[Pull request](./pull-request)
10 changes: 10 additions & 0 deletions docs/common/pull-request.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 1 addition & 3 deletions docs/js.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
6 changes: 2 additions & 4 deletions docs/php.md
Original file line number Diff line number Diff line change
@@ -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)
[API-Platform](./api-platform)
12 changes: 9 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
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',
organizationName: 'Mapado', // Usually your GitHub org/user name.
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/',
Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ module.exports = {
'js/testing',
],
php: ['php', 'php/php', 'php/symfony', 'php/api-plaform'],
common: ['common', 'common/pull-request'],
};
10 changes: 10 additions & 0 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,16 @@ function Home() {
<h1 className="hero__title">{siteConfig.title}</h1>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link
className={classnames(
'button button--outline button--secondary button--lg',
styles.getStarted
)}
to={useBaseUrl('docs/common/')}
>
Général
</Link>
&nbsp;
<Link
className={classnames(
'button button--outline button--secondary button--lg',
Expand Down

0 comments on commit aefcab6

Please sign in to comment.