Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add K&R code style checker workflow #3005

Open
wants to merge 1 commit into
base: alpha
Choose a base branch
from

Conversation

kwizer15
Copy link
Contributor

Ajout d'un vérificateur de style K&R

Description

Cette PR ajoute un système de vérification automatique du style de code K&R avec une approche non disruptive :

Principales fonctionnalités

  • Workflow GitHub Actions qui vérifie uniquement les lignes modifiées lors des PR
  • Script de vérification utilisable en local
  • Documentation multilingue (FR/EN/DE/ES)
  • Possibilité de correction automatique via phpcbf
  • Support pour git pre-commit hook

Composants ajoutés

  • .github/workflows/phpcs.yml : Configuration du workflow GitHub
  • .github/scripts/check-style.sh : Script de vérification
  • .github/phpcs/kr.xml : Règles de style K&R
  • docs/{lang}/code-styling.md : Documentation dans différentes langues

Impact sur le code existant

  • Aucune modification du code existant
  • Les vérifications ne s'appliquent qu'aux nouvelles modifications
  • Installation et utilisation optionnelles pour les développeurs

Tests effectués lors du développement de la PR

  • Vérification locale sur différentes modifications
  • Test du workflow GitHub sur des PR de test
  • Validation des règles K&R sur le code nouveau vs existant

Notes

Le système respecte le style historique du projet tout en fournissant des outils pour maintenir la cohérence sur les nouvelles contributions.

Suggested changelog entry

Added K&R style checking system

Related issues/external references

N/A

Types of changes

  • Bug fix (non-breaking change which fixes)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
    • This change is only breaking for integrators, not for external standards or end-users.
  • Documentation improvement

PR checklist

- Add GitHub Actions workflow for PR style validation
- Setup K&R style ruleset based on original Jeedom conventions
- Check only modified PHP files in PR
- Provide feedback as PR comments
- Keep the process external to project dependencies
@kwizer15 kwizer15 force-pushed the feat/knr-style-check branch from 86a4fe4 to c78eebb Compare December 23, 2024 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant