sktime/sktime

[MNT] `agents.md` with pointers to pre-commit, docs and code formatting

Ouverte

#9 368 ouverte le 13 févr. 2026

Voir sur GitHubGuide contributeur
 (13 commentaires) (0 réaction) (0 personne assignée)Python (1 192 forks)batch import
good first issuemaintenance

Métriques du dépôt

Stars
 (7 162 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

An agents.md should be written with info for agents. Ensure to include:

  • pre-commit reference in order to pass code-quality test
  • new estimators should be added to the docs, api_reference
  • estimators should follow templates in the extension_template dir

Guide contributeur

Direction de recherche
Créez un fichier agents.md dans la racine du dépôt ou dans le dossier docs. Incluez des liens vers la configuration pre commit pour passer les tests de qualité du code, des instructions sur la façon d'ajouter de nouveaux estimateurs à la documentation de référence de l'API, et des références aux modèles d'extension dans le répertoire extension template. Consultez les fichiers similaires existants ou les discussions d'issues pour des exemples.
Stack technique
python
Domaine
developer experiencedocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75