libgit2 / libgit2/libgit2sharp
Improve GlobalSettings documentation with regards to shared state "dragons"
Personne n'a encore pris cette issue.
- Langage dominant
- C#
- Étoiles
- 3.5k
- Forks
- 925
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
From #1119
maybe should we also improve the documentation of this type. Indeed, this type holds registrations that exceeds the lifespan of a
Repository.I feel that pretty strange side-effects may happen would we blindly deregister while some repos are still alive and leveraging those.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Repérez la documentation de GlobalSettings et la documentation associée au cycle de vie de Repository. Lisez comment les enregistrements de GlobalSettings persistent au-delà d’un Repository, puis mettez à jour la documentation pour expliquer les risques liés à l’état partagé et pourquoi la désinscription doit tenir compte des autres repositories encore actifs ; le travail est terminé lorsque le comportement et la mise en garde sont clairement documentés.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- csharp
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 30/100