4nk/sdk_client
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ci: docker_tag=dev-test - Centralisation des fichiers CODE_OF_CONDUCT, CODEOWNERS, CONTRIBUTING, LICENSE

Browse Source
This commit is contained in:
4NK Dev 2025-10-01 21:05:50 +00:00
parent 0d5e181c82
commit 89f75321b0
4 changed files with 10 additions and 486 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
CODE_OF_CONDUCT.md
View File

@ -1,93 +0,0 @@
# Code de Conduite - 4NK Node
## Notre Engagement
Dans l'intérêt de favoriser un environnement ouvert et accueillant, nous, en tant que contributeurs et mainteneurs, nous engageons à faire de la participation à notre projet et à notre communauté une expérience sans harcèlement pour tous, peu importe l'âge, la taille, le handicap, l'ethnicité, les caractéristiques sexuelles, l'identité et l'expression de genre, le niveau d'expérience, l'éducation, le statut socio-économique, la nationalité, l'apparence personnelle, la race, la religion ou l'identité et l'orientation sexuelles.
## Nos Standards
Exemples de comportements qui contribuent à créer un environnement positif :
* Utiliser un langage accueillant et inclusif
* Respecter les différents points de vue et expériences
* Accepter gracieusement les critiques constructives
* Se concentrer sur ce qui est le mieux pour la communauté
* Faire preuve d'empathie envers les autres membres de la communauté
Exemples de comportements inacceptables :
* L'utilisation de langage ou d'imagerie sexualisés et d'attention ou d'avances sexuelles non désirées
* Le trolling, les commentaires insultants/désobligeants et les attaques personnelles ou politiques
* Le harcèlement public ou privé
* Publier les informations privées d'autres personnes, telles que des adresses physiques ou électroniques, sans permission explicite
* Autres comportements qui pourraient raisonnablement être considérés comme inappropriés dans un contexte professionnel
## Nos Responsabilités
Les mainteneurs du projet sont responsables de clarifier les standards de comportement acceptable et sont censés prendre des mesures correctives appropriées et équitables en réponse à tout cas de comportement inacceptable.
Les mainteneurs du projet ont le droit et la responsabilité de supprimer, modifier ou rejeter les commentaires, commits, code, modifications de wiki, questions et autres contributions qui ne sont pas alignés avec ce Code de Conduite, et de bannir temporairement ou définitivement tout contributeur pour d'autres comportements qu'ils jugent inappropriés, menaçants, offensants ou nuisibles.
## Portée
Ce Code de Conduite s'applique à la fois dans les espaces du projet et dans les espaces publics lorsqu'un individu représente le projet ou sa communauté. Des exemples de représentation du projet ou de la communauté incluent l'utilisation d'une adresse email officielle du projet, la publication via un compte de média social officiel, ou l'action en tant que représentant désigné lors d'un événement en ligne ou hors ligne. La représentation du projet peut être davantage définie et clarifiée par les mainteneurs du projet.
## Application
Les cas de comportement abusif, harcelant ou autrement inacceptable peuvent être signalés en contactant l'équipe du projet à contact@4nkweb5.com. Toutes les plaintes seront examinées et enquêtées et se traduiront par une réponse jugée nécessaire et appropriée aux circonstances. L'équipe du projet est obligée de maintenir la confidentialité concernant le rapporteur d'un incident. Plus de détails sur les politiques d'application spécifiques peuvent être publiés séparément.
Les mainteneurs du projet qui ne suivent pas ou n'appliquent pas le Code de Conduite de bonne foi peuvent faire face à des répercussions temporaires ou permanentes déterminées par d'autres membres de la direction du projet.
## Attribution
Ce Code de Conduite est adapté du [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, disponible à https://www.contributor-covenant.org/fr/version/2/0/code_of_conduct.html.
## Contact
Pour signaler un problème ou poser des questions concernant ce Code de Conduite, vous pouvez :
* Créer une issue privée sur le repository
* Contacter l'équipe de maintenance via les canaux officiels
* Utiliser les canaux de discussion du projet
## Équipe de Modération
L'équipe de modération est composée des mainteneurs principaux du projet qui s'engagent à :
* Traiter tous les signalements avec impartialité
* Maintenir la confidentialité des rapports
* Prendre des mesures appropriées et équitables
* Documenter les décisions prises
* Améliorer continuellement le processus
## Processus de Signalement
1. **Signalement** : Contactez l'équipe via les canaux appropriés
2. **Accusé de réception** : Vous recevrez une confirmation dans les 48h
3. **Enquête** : L'équipe examinera le signalement
4. **Décision** : Une décision sera prise et communiquée
5. **Appel** : Possibilité de faire appel de la décision
## Mesures Correctives
Les mesures correctives peuvent inclure :
* Avertissement privé
* Avertissement public
* Suspension temporaire
* Bannissement permanent
* Suppression de contenu inapproprié
## Engagement envers l'Amélioration
Nous nous engageons à :
* Réviser régulièrement ce Code de Conduite
* Solliciter les retours de la communauté
* Améliorer les processus de modération
* Former l'équipe de modération
* Maintenir un environnement sain et inclusif
---
**Merci de contribuer à maintenir 4NK Node comme un projet accueillant et inclusif !** 🌟

372
CONTRIBUTING.md
View File

@ -1,372 +0,0 @@
# Guide de Contribution - 4NK Node
Merci de votre intérêt pour contribuer au projet 4NK Node ! Ce guide vous aidera à comprendre comment participer au développement de cette infrastructure pour les paiements silencieux Bitcoin.
## 📋 Table des Matières
- [🎯 Comment Contribuer](#-comment-contribuer)
- [🚀 Premiers Pas](#-premiers-pas)
- [🔧 Environnement de Développement](#️-environnement-de-développement)
- [📝 Processus de Contribution](#-processus-de-contribution)
- [🧪 Tests](#-tests)
- [📚 Documentation](#-documentation)
- [🐛 Signaler un Bug](#-signaler-un-bug)
- [💡 Proposer une Fonctionnalité](#-proposer-une-fonctionnalité)
- [🔍 Code Review](#-code-review)
- [📦 Release](#-release)
## 🎯 Comment Contribuer
### Types de Contributions
Nous accueillons différents types de contributions :
- **🐛 Bug fixes** - Correction de bugs et problèmes
- **✨ Nouvelles fonctionnalités** - Ajout de nouvelles capacités
- **📚 Documentation** - Amélioration de la documentation
- **🧪 Tests** - Ajout ou amélioration des tests
- **🔧 Outils** - Amélioration des scripts et outils
- **🌐 Traductions** - Traduction de la documentation
- **📊 Performance** - Optimisations de performance
- **🔒 Sécurité** - Améliorations de sécurité
### Niveaux de Contribution
- **Débutant** - Documentation, tests, petits bugs
- **Intermédiaire** - Nouvelles fonctionnalités, améliorations
- **Avancé** - Architecture, optimisations majeures
## 🚀 Premiers Pas
### Prérequis
- **Docker** et **Docker Compose** installés
- **Git** configuré
- **Python 3.8+** (pour les tests)
- **Rust** (pour le développement sdk_relay)
- **Connexion Internet** stable
### Fork et Clone
```bash
# 1. Fork le repository sur Gitea
# 2. Clone votre fork
git clone https://git.4nkweb.com/votre-username/4NK_node.git
cd 4NK_node
# 3. Ajouter le repository original comme upstream
git remote add upstream https://git.4nkweb.com/4nk/4NK_node.git
```
### Branches
```bash
# Créer une branche pour votre contribution
git checkout -b feature/nom-de-votre-feature
# ou
git checkout -b fix/nom-du-bug
```
## 🔧 Environnement de Développement
### Installation Locale
```bash
# 1. Cloner le repository
git clone https://git.4nkweb.com/4nk/4NK_node.git
cd 4NK_node
# 2. Démarrer l'infrastructure
./restart_4nk_node.sh
# 3. Vérifier que tout fonctionne
docker ps
```
### Configuration de Développement
```bash
# Variables d'environnement pour le développement
export RUST_LOG=debug
export ENABLE_SYNC_TEST=1
export BITCOIN_NETWORK=signet
```
### Outils de Développement
```bash
# Tests
./tests/run_all_tests.sh
# Linting (si configuré)
cargo clippy
rustfmt src/
# Build
docker-compose build
```
## 📝 Processus de Contribution
### 1. Planifier Votre Contribution
- [ ] Vérifier les issues existantes
- [ ] Créer une issue si nécessaire
- [ ] Discuter de l'approche avec l'équipe
- [ ] Planifier les tests et la documentation
### 2. Développer
- [ ] Créer une branche depuis `main`
- [ ] Développer votre fonctionnalité
- [ ] Ajouter des tests
- [ ] Mettre à jour la documentation
- [ ] Vérifier que les tests passent
### 3. Soumettre
- [ ] Commiter avec des messages clairs
- [ ] Pousser vers votre fork
- [ ] Créer une Pull Request
- [ ] Remplir le template de PR
### Messages de Commit
Utilisez le format conventionnel :
```bash
# Format
type(scope): description
# Exemples
feat(sdk_relay): add new sync type for metrics
fix(bitcoin): resolve connection timeout issue
docs(api): update WebSocket message format
test(integration): add multi-relay sync tests
```
**Types :**
- `feat` - Nouvelle fonctionnalité
- `fix` - Correction de bug
- `docs` - Documentation
- `style` - Formatage
- `refactor` - Refactoring
- `test` - Tests
- `chore` - Maintenance
## 🧪 Tests
### Exécuter les Tests
```bash
# Tous les tests
./tests/run_all_tests.sh
# Tests par catégorie
./tests/run_unit_tests.sh
./tests/run_integration_tests.sh
./tests/run_connectivity_tests.sh
./tests/run_external_tests.sh
# Tests avec debug
./tests/run_all_tests.sh --debug
```
### Ajouter des Tests
```bash
# Structure recommandée
tests/
├── unit/ # Tests unitaires
├── integration/ # Tests d'intégration
├── connectivity/ # Tests de connectivité
├── external/ # Tests externes
└── performance/ # Tests de performance
```
### Bonnes Pratiques
- Testez tous les cas d'usage
- Incluez des tests d'erreur
- Maintenez une couverture > 80%
- Utilisez des données de test réalistes
## 📚 Documentation
### Mise à Jour de la Documentation
```bash
# Structure de la documentation
docs/
├── INSTALLATION.md # Guide d'installation
├── USAGE.md # Guide d'utilisation
├── CONFIGURATION.md # Guide de configuration
├── ARCHITECTURE.md # Architecture technique
├── API.md # Référence API
├── TESTING.md # Guide des tests
└── INDEX.md # Index principal
```
### Standards de Documentation
- Utilisez le Markdown
- Incluez des exemples de code
- Ajoutez des diagrammes si nécessaire
- Maintenez la cohérence du style
- Traduisez en anglais si possible
## 🐛 Signaler un Bug
### Template de Bug Report
```markdown
## Description du Bug
Description claire et concise du problème.
## Étapes pour Reproduire
1. Aller à '...'
2. Cliquer sur '...'
3. Faire défiler jusqu'à '...'
4. Voir l'erreur
## Comportement Attendu
Description de ce qui devrait se passer.
## Comportement Actuel
Description de ce qui se passe actuellement.
## Informations Système
- OS: [ex: Ubuntu 20.04]
- Docker: [ex: 20.10.0]
- Version: [ex: v1.0.0]
## Logs
```
Logs pertinents ici
```
## Capture d'Écran
Si applicable, ajoutez une capture d'écran.
## Contexte Supplémentaire
Toute autre information pertinente.
```
## 💡 Proposer une Fonctionnalité
### Template de Feature Request
```markdown
## Résumé
Description claire et concise de la fonctionnalité souhaitée.
## Motivation
Pourquoi cette fonctionnalité est-elle nécessaire ?
## Proposition
Description détaillée de la fonctionnalité proposée.
## Alternatives Considérées
Autres solutions envisagées.
## Impact
Impact sur les utilisateurs et l'architecture.
## Exemples d'Utilisation
Comment cette fonctionnalité serait-elle utilisée ?
```
## 🔍 Code Review
### Processus de Review
1. **Automatique** - Tests et linting
2. **Review par l'équipe** - Code review manuel
3. **Tests d'intégration** - Validation complète
4. **Approbation** - Merge dans main
### Critères de Review
- [ ] Code fonctionnel et testé
- [ ] Tests ajoutés/modifiés
- [ ] Documentation mise à jour
- [ ] Pas de régression
- [ ] Performance acceptable
- [ ] Sécurité vérifiée
### Répondre aux Reviews
- Répondez poliment aux commentaires
- Apportez les modifications demandées
- Demandez des clarifications si nécessaire
- Re-merguez après les corrections
## 📦 Release
### Processus de Release
1. **Préparation** - Finaliser les fonctionnalités
2. **Tests** - Tests complets
3. **Documentation** - Mise à jour des docs
4. **Tag** - Créer un tag de version
5. **Release** - Publier sur GitHub/GitLab
6. **Annonce** - Communiquer la release
### Numérotation des Versions
Utilisez le [Semantic Versioning](https://semver.org/) :
- **MAJOR** - Changements incompatibles
- **MINOR** - Nouvelles fonctionnalités compatibles
- **PATCH** - Corrections de bugs compatibles
## 🤝 Communauté
### Communication
- **Issues** - Pour les bugs et fonctionnalités
- **Discussions** - Pour les questions générales (via les issues)
- **Pull Requests** - Pour les contributions
- **Wiki** - Pour la documentation collaborative (si activé sur Gitea)
### Code de Conduite
- Soyez respectueux et inclusif
- Écoutez les autres points de vue
- Contribuez de manière constructive
- Respectez les standards du projet
### Reconnaissance
- Les contributeurs sont listés dans le README
- Les contributions significatives sont reconnues
- Les releases mentionnent les contributeurs
## 🆘 Besoin d'Aide ?
- Consultez la [documentation](docs/)
- Vérifiez les [issues existantes](https://git.4nkweb.com/4nk/4NK_node/issues)
- Posez une question via les [issues](https://git.4nkweb.com/4nk/4NK_node/issues/new)
- Contactez l'équipe de maintenance
## 📄 Licence
En contribuant, vous acceptez que vos contributions soient sous la même licence que le projet (MIT).
---
Merci de contribuer à 4NK Node ! 🚀

21
LICENSE
View File

@ -1,21 +0,0 @@
MIT License
Copyright (c) 2024 4NK Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

10
README.md
View File

@ -32,3 +32,13 @@ Consulter `docs/TESTING.md` (section WASM Windows) pour les variables d’enviro
---
Documentation de référence: voir `docs/` pour la table des matières.
## 📋 Fichiers centralisés
Les fichiers suivants sont centralisés dans le dépôt principal `4NK_env` :
- `CODE_OF_CONDUCT.md` - Code de conduite
- `CODEOWNERS` - Propriétaires du code
- `CONTRIBUTING.md` - Guide de contribution
- `LICENSE` - Licence du projet
Voir : [`4NK_env/CODE_OF_CONDUCT.md`](../../CODE_OF_CONDUCT.md), [`4NK_env/CODEOWNERS`](../../CODEOWNERS), [`4NK_env/CONTRIBUTING.md`](../../CONTRIBUTING.md), [`4NK_env/LICENSE`](../../LICENSE)