Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: First draft to help getting the code #71

Merged
merged 2 commits into from
Nov 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions doc_developer/getting_the_code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Getting the code

This document explains how to get the source code for NumPy-Financial using Git.

## Code Location

NumPy-Financial is hosted on GitHub. The repository URL is https://github.com/numpy/numpy-financial.

## Creating a fork

To create a fork click the green "fork" button at the top right of the page. This creates a new repository on your
GitHub profile. This will have the URL: https://github.com/<your_username>/numpy-financial.

## Cloning the repository

Now that you have forked the repository you will need to clone it. This copies the repository from GitHub to the local
machine. To clone a repository enter the following commands in the terminal.

```shell
git clone https://github.com/<your_username>/numpy-financial.git
```

Hooray! You now have a working copy of NumPy-Financial.


## Updating the code with other's changes

From time to time you may want to pull down the latest code. Do this with:

```shell
git fetch
```

The `git fetch` command downloads commits, files and refs from a remote repo into your local repo.

Then run:

```shell
git merge --ff-only
```

The `git merge` command is Git's way of putting independent branches back together. The `--ff-only` flag tells git to
use `fast-forward` merges. This is preferable as fast-forward merge avoids creating merge commits.