Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

37 lines (30 loc) · 1.24 KB
Raw

Contributing to BANKI

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Pull requests

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/BANKI.git
# Navigate to the newly cloned directory
cd BANKI
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/curtisbarnard/BANKI.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout main
git pull upstream main

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream main

  5. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  6. Open a Pull Request with a clear title and description.