Pour contribuer au code ou à la documentation, vous devez d'abord

  1. git installé sur votre machine
  2. un compte GitHub
  3. un fork de NumPy

Installer git

Vous avez peut-être déjà git ; vérifiez en tapant git --version. S'il est installé, vous verrez une variation de git version 2.11.0. Si à la place vous voyez command is not recognized, command not
found
, etc, installez git.

Ensuite, définissez votre nom et votre email :

git config --global user.email [email protected].example.com
git config --global user.name "Your Name"

Créez un compte GitHub

Si vous n'avez pas de compte GitHub, rendez-vous sur le site https://github.com/join pour en créer un.

Créez une fourche NumPy

Forking a deux étapes - visitez GitHub pour créer un repo fork dans votre compte, puis faites une copie de celui-ci sur votre propre machine.

Créer le repo fork

  1. Connectez-vous à votre compte GitHub.
  2. Allez sur le NumPy GitHub home.
  3. En haut à droite de la page, cliquez sur Fork:

    ../../_images/Forking_button.png

    Vous verrez

    ../../_images/forking_message.png

    et vous serez alors dirigé vers la page d'accueil de votre copie fourchue :

    ../../_images/forked_page.png

Faites la copie locale

  1. Dans le répertoire où vous voulez que la copie soit créée, exécutez .

    git clone https://github.com/your-user-name/numpy.git
    

    Vous verrez quelque chose comme :

    $ git clone https://github.com/your-user-name/numpy.git
    Cloning into 'numpy'...
    remote: Enumerating objects:12, done.
    remote: Counting objects:100%(12/12), done.
    remote: Compressing objects:100%(12/12), done.
    remote: Total 175837(delta 0), reused 0(delta 0), pack-reused 175825
    Receiving objects:100%(175837/175837),78.16 MiB |9.87 MiB/s, done.
    Resolving deltas:100%(139317/139317), done.

    Un répertoire numpy est créé sur votre machine. (Si vous disposez déjà d'un répertoire numpy, GitHub choisira un nom différent comme . numpy-1.)

    $ ls -l
    total 0
    drwxrwxrwx 1 bjn bjn 4096 Jun 2007:20 numpy
    
  1. Donnez le nom upstream au repo principal de NumPy :

    cd numpy
    git remote add upstream https://github.com/numpy/numpy.git
    
  2. Configurez votre dépôt de sorte que git pull tire de upstream par défaut :

    git config branch.master.remote upstream
    git config branch.master.merge refs/heads/master
    

Regardez-le

  1. Les branches montrées par git branch -a comprendront

    • le site master branche que vous venez de cloner sur votre propre machine
    • le master branche de votre fork sur GitHub, que git a nommé origin par défaut
    • le master branche sur le repo principal de NumPy, que vous avez nommée. upstream.
    master
    remotes/origin/master
    remotes/upstream/master
    

    Si upstream n'est pas là, elle sera ajoutée après que vous ayez accédé au repo NumPy avec une commande telle que git fetch ou git pull.

  2. Les dépôts indiqués par git remote -v show comprendront votre fork sur GitHub et le repo principal :

    upstream    https://github.com/numpy/numpy.git (fetch)
    upstream    https://github.com/numpy/numpy.git (push)
    origin      https://github.com/your-user-name/numpy.git (fetch)
    origin      https://github.com/your-user-name/numpy.git (push)
  3. git config --list inclura

    user.email=[email protected].com
    user.name=Your Name
    remote.origin.url=[email protected].com:your-github-id/numpy.git
    remote.origin.fetch=+refs/heads/*:refs/remotes/origin/*
    branch.master.remote=upstream
    branch.master.merge=refs/heads/master
    remote.upstream.url=https://github.com/numpy/numpy.git
    remote.upstream.fetch=+refs/heads/*:refs/remotes/upstream/*

Facultatif : configurer les clés SSH pour éviter les mots de passe.

Le clonage de votre repo NumPy fork n'a pas nécessité de mot de passe, car il a lu le repo distant sans le modifier. Plus tard, cependant, la soumission de vos demandes de pull y écrira, et GitHub vous demandera votre nom d'utilisateur et votre mot de passe - même si c'est votre propre repo. Vous pouvez éliminer cette authentification sans compromettre la sécurité en configurant des clés SSH .

Si vous configurez les clés avant le clonage, les instructions ci-dessus changent légèrement. Au lieu de

git clone https://github.com/your-user-name/numpy.git

exécutez

git clone [email protected]:numpy/numpy.git

et au lieu de montrer un https URL, git remote -v affichera

origin  [email protected]:your-user-name/numpy.git (fetch)
origin  [email protected]:your-user-name/numpy.git (push)

Si vous avez déjà cloné et que vous voulez commencer à utiliser SSH, voir Basculer les URL distantes de HTTPS à SSH. .