libgit2 / libgit2/pygit2

Documentation is missing pygit2 install from repository checkout instructions

Ouverte
#929 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
1.7k
Forks
408
Merge moyen
2 j 57 min
PR mergées (30 j)
7

Description

The Advanced installation instructions don't provide any guidance on installing pygit2 from a repository checkout.

There are instructions for installing libgit2 but then for pygit2 it only says the following:

Now install pygit2, and then verify it is correctly installed:
$ pip install pygit2

This will install the latest released version but not a version checked out from the repository.

Looking at what is provided in the Makefile the following is a reasonable guess and seems to work

cd pygit2
sudo python install

or in my case sudo python3 install.

It would be helpful if the documentation contained some verification that this is recommended method when installing from a repository checkout.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les instructions d’installation avancées et le Makefile du dépôt. Comparez les étapes existantes pour libgit2 et pygit2, documentez la méthode prise en charge pour installer pygit2 depuis un checkout du dépôt, et incluez une vérification indiquant que la version du checkout a été installée.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
58/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.