Beginner guide

Using your project repository

You do not need previous Git experience. Follow these steps in order to download the project, work safely, and save your changes to GitHub.

01

Before you start

Accept repository access

After purchase, repository access is sent to the GitHub username provided during checkout. Open the invitation while signed in to that same GitHub account and accept it.

If the repository shows a 404 page, first check the GitHub account shown in the top-right corner. A private repository is visible only to the account that received access.

Install Git

Download Git from the official Git website. Windows users can open Git Bash after installation. macOS and Linux users can use Terminal.

git --version

A version number confirms that Git is installed.

Set your name and email once

Use the name you want recorded beside your commits. Use an email connected to your GitHub account if you want the commits linked to your profile.

git config --global user.name "YOUR NAME"
git config --global user.email "YOUR-EMAIL@example.com"
02

Clone the project

Cloning creates a complete working copy of the private GitHub repository on your computer.

  1. Open the project repository on GitHub.
  2. Select the green Code button.
  3. Select HTTPS and copy the repository URL.
  4. Open Terminal or Git Bash.
  5. Move to the folder where you keep projects.
  6. Run git clone with the copied URL.
git clone https://github.com/geniusproject-store/PROJECT-NAME.git
cd PROJECT-NAME
git status

GitHub may open a browser window for sign-in. Use the account that received repository access. Your normal GitHub password is not accepted as a command-line Git password.

Do this only once.

After cloning, use the existing project folder. Do not clone a fresh copy every time you work.

03

Open and run the project

Start with the repository’s README.md and setup guide. They contain the exact software, version, installation, dataset, and run instructions for that project.

git branch --show-current
git log --oneline -5

The first command shows your current branch. The second shows the five most recent saved changes.

  • Read the complete README before installing packages.
  • Use the software versions listed on the project page and in the repository.
  • Copy example environment files instead of editing or committing real secrets.
  • Run the included baseline or verification case before changing anything.
04

Save your work

A commit is a named checkpoint. Create small commits that describe one logical change.

1. See what changed

git status
git diff

2. Select the files to save

git add path/to/file

Add files deliberately. Check git status again before committing.

3. Create the checkpoint

git commit -m "Explain the change clearly"

4. Send it to GitHub

git push
A useful commit message

Write what changed, such as “Add mesh convergence comparison” or “Correct dataset preprocessing”. Avoid messages such as “update”, “work”, or “final”.

05

Use a branch for larger changes

A branch keeps experimental work separate from the stable main branch.

git switch -c experiment/mesh-study

Make changes and commit them normally. The first push for a new branch needs this command:

git push -u origin experiment/mesh-study

After that, git push is enough. Use a short branch name that explains the work.

06

Get updates safely

Commit or set aside your own changes before pulling updates.

git status
git pull --ff-only

The --ff-only option stops instead of creating an unexpected merge commit. If it stops, do not force the pull. Read the message and resolve your local work first.

07

Fix common mistakes

Unstage a file but keep your changes

git restore --staged path/to/file

Discard an uncommitted file change

git restore path/to/file

Warning: this permanently discards the uncommitted changes in that file. Check git diff first.

Correct the most recent commit message

git commit --amend -m "Correct message"

Use amend only before pushing that commit. Do not rewrite shared history.

See where a remote points

git remote -v
Do not force push.

Avoid git push --force, destructive reset commands, and deleting the main branch. Ask for help when history has diverged.

08

Common problems

Repository not found
Confirm that you accepted the invitation and are signed in to the GitHub account named during purchase.
Authentication failed
Use browser authentication or Git Credential Manager. GitHub does not accept your account password as a command-line Git password.
Working tree is not clean
Run git status. Commit the changes you want to keep or restore only the files you intentionally want to discard.
Push was rejected
The remote has work you do not have locally. Commit your work, run git pull --ff-only, and ask for help if Git reports diverging branches.
Merge conflict
Open each conflicted file, choose the correct content, remove the conflict markers, test the result, then add and commit the resolved files.
Large or secret file committed
Stop before pushing. Remove the file from the commit and rotate any exposed credential. Deleting a secret in a later commit does not remove it from history.
09

Keep the repository safe

  • Never commit passwords, tokens, API keys, private keys, or real personal data.
  • Do not commit .env files unless the repository explicitly contains a safe example file.
  • Do not commit dependency folders, build output, large simulation results, or generated datasets unless the guide requires them.
  • Keep the repository private and do not add collaborators without permission.
  • Push useful checkpoints regularly so your work is not stored on only one computer.

For the official reference, see GitHub’s guides to cloning a repository and GitHub authentication.