Files
o-k-i.net/CONTRIBUTING.md
2025-11-05 17:41:27 +04:00

3.2 KiB

Guide de contribution

Merci de votre intérêt pour contribuer au site dE l'ORGANISATION KA INTERNATIONALE !

Ajouter du contenu

Ajouter un service Fédiverse

Éditez src/_data/services.json :

{
  "name": "NOM_DU_SERVICE",
  "icon": "🎯",
  "platform": "Nom de la plateforme",
  "description": "Description du service",
  "url": "https://service.o-k-i.net/",
  "linkText": "Accéder à SERVICE"
}

Ajouter un projet web

Éditez src/_data/projects.json :

{
  "name": "NOM.PROJET",
  "icon": "📱",
  "domain": "nom.projet",
  "description": "Description du projet"
}

Ajouter une valeur

Éditez src/_data/values.json :

{
  "icon": "🌟",
  "title": "Titre",
  "description": "Description de la valeur"
}

Modifier la navigation

Éditez src/_data/navigation.json :

{
  "text": "Texte du lien",
  "url": "#section",
  "external": false
}

Pour un lien externe, mettez "external": true.

Ajouter une section de contact

Éditez src/_data/contact.json :

{
  "title": "🔗 Titre de la section",
  "links": [
    {
      "text": "Nom du lien",
      "url": "https://example.com"
    }
  ]
}

Modifier les styles

Les styles sont dans src/assets/css/styles.css.

Variables CSS disponibles

--bleu-ocean: #003566;
--jaune-soleil: #FFB700;
--rouge-resistance: #D62828;
--vert-terre: #2A9134;
--orange-communaute: #FB8500;
--noir-profond: #0A0908;
--blanc-lumiere: #F7F7F2;
--violet-fedi: #6364FF;

Créer une nouvelle page

  1. Créez un fichier .njk dans src/ :
---
layout: layouts/base.njk
title: Titre de la page
description: Description pour le SEO
---

<section>
  <h1>{{ title }}</h1>
  <p>Contenu de votre page</p>
</section>
  1. Ajoutez le lien dans src/_data/navigation.json si nécessaire

  2. Reconstruisez le site : npm run build

Modifier un partial

Les partials sont dans src/_includes/partials/ :

  • nav.njk - Navigation
  • hero.njk - Section hero (accueil)
  • fediverse.njk - Services Fédiverse
  • projects.njk - Projets web
  • mission.njk - Mission et valeurs
  • hosting.njk - Services d'hébergement
  • support.njk - Section dons
  • contact.njk - Informations de contact
  • footer.njk - Pied de page

Workflow de développement

  1. Créez une branche pour votre fonctionnalité :

    git checkout -b feature/ma-fonctionnalite
    
  2. Faites vos modifications

  3. Testez localement :

    npm start
    
  4. Buildez pour vérifier :

    npm run build
    
  5. Commitez vos changements :

    git add .
    git commit -m "Description de vos changements"
    
  6. Poussez et créez une pull request :

    git push origin feature/ma-fonctionnalite
    

Standards de code

HTML/Nunjucks

  • Indentation : 4 espaces
  • Toujours fermer les balises
  • Attributs entre guillemets doubles

CSS

  • Indentation : 4 espaces
  • Utiliser les variables CSS quand possible
  • Mobile-first pour le responsive

JavaScript

  • Indentation : 4 espaces
  • Vanilla JS (pas de framework)
  • Commentaires en français
  • Gestion des erreurs

Questions ?

Contactez-nous à kontak@o-k-i.net ou ouvrez une issue sur Codeberg.