Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

64 lines (44 loc) · 1.95 KB
Raw

Contributing guidelines

Contents

General guidelines

  • When contributing to this repository, please first inform or discuss the change(s) you wish to make via an issue. This helps in letting others know what you're working on.

  • Before you push your changes to GitHub, make sure that your code compiles and runs without any errors or warnings.

Pull requests

Follow the steps below when making changes to the project and to submit a PR:

  1. Fork the repo (once).

  2. Clone your fork and configure the remote (once per clone):

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/BigInt.git

# Navigate to the newly cloned directory
cd BigInt

# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/faheel/BigInt.git

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

    git checkout master
git pull upstream master

  4. Create a new branch (off the master branch) for the changes you're about to make:

    git checkout -b <branch-name>

  5. Commit your changes in logical chunks. Use Git's interactive rebase feature to tidy up your commits before making them public.

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

    git pull [--rebase] upstream master

  7. Push your branch up to your fork:

    git push origin <branch-name>

  8. Open a pull request with a clear title and description against the master branch.

Code of Conduct

This project has a Code of Conduct. Please follow it in all your interactions with the project.