Bedrud Documentation

Les contributions à Bedrud sont les bienvenues. Ce guide couvre le processus de soumission des modifications.

Note : Le guide de contribution canonique se trouve à la racine du dépôt : CONTRIBUTING.md. Cette page est archivée pour référence uniquement.

Pour Commencer

  1. Fork le dépôt
  2. Clonez votre fork
  3. Créez une branche de fonctionnalité à partir de main
  4. Effectuez vos modifications
  5. Soumettez une pull request

Prérequis

  • Go 1.22+
  • Bun (pour le frontend web)
  • Rust (pour l’application de bureau)
  • Make
  • Git

Configuration du Développement

# Après avoir forké sur GitHub, clonez votre fork
git clone https://github.com/<votre-nom-d-utilisateur>/bedrud.git
cd bedrud
make init
make dev

Consultez le Workflow de développement pour des instructions de configuration détaillées.

Structure du Projet

RépertoireLangageDescription
server/GoAPI backend et LiveKit intégré
apps/web/TypeScript/ReactFrontend web
apps/desktop/Rust + SlintApplication de bureau
apps/android/KotlinApplication Android
apps/ios/SwiftApplication iOS
agents/PythonAgents de bot
packages/TypeScriptDéfinitions de types partagés
tools/cli/PythonCLI de déploiement
docs/MarkdownDocumentation

Style de Code

LangageStandard
Gogofmt
TypeScript/ReactBiome
KotlinAndroid Studio defaults
SwiftXcode defaults
Pythonruff

Processus de Pull Request

  1. Nom de branche : feature/description, fix/description ou docs/description
  2. Messages de commit : <action> <quoi> pour <pourquoi> (par exemple, add user model for auth feature, fix login redirect for expired sessions)
  3. Vérifications CI : Toutes les vérifications GitHub Actions doivent réussir
  4. Description : Incluez ce qui a changé et pourquoi

Vérifications CI

Chaque PR exécute automatiquement ces vérifications :

VérificationCe qu’elle valide
Servergo vet, build, tests
WebTypeScript type check, build
AndroidLint, unit tests
iOSBuild, test (simulator)

Signaler des Problèmes

Signalez les problèmes sur GitHub Issues avec :

  • Les étapes pour reproduire
  • Le comportement attendu vs réel
  • Les détails de l’environnement (OS, navigateur, version de l’application)

Documentation

La documentation se trouve dans docs/ et est construite avec MkDocs Material.

Aperçu Local

pip install mkdocs-material
mkdocs serve

Ensuite, ouvrez http://localhost:8000 dans votre navigateur.

Structure

Les pages de documentation sont organisées par sujet. La navigation est définie dans mkdocs.yml à la racine du projet.

Licence

En contribuant, vous acceptez que vos contributions seront licenciées sous la Licence Apache 2.0.