AI vector Forge

Syncing Your Repo When `base` is Updated

This guide explains how to sync your repository with the latest changes from the attogram/base template repository. This is for repositories that were created using the “Use this template” button on GitHub.

This process assumes that you have not previously added the base repository as a remote. If you have, you can skip to the fetch and merge steps.

There are two ways to do this: an easy method using the GitHub web interface, and an advanced method using the command line on your local machine.

Easy Method: Using GitHub Codespaces (Web-Based)

This method is recommended if you are not familiar with the command line or do not have Git installed on your machine. It uses GitHub Codespaces, which provides a development environment that runs in your browser.

Navigate to Your Repository: Go to the main page of your own existing repository on GitHub.
Launch a New Codespace:
- Click the “<> Code” button.
- Go to the “Codespaces” tab.
- Click “Create codespace on [your-branch-name]”. This will create a new development environment and open it in a new browser tab.
Open the Terminal: Once the Codespace has loaded, you will see a code editor and a file browser. You need to open the terminal:
- Click the “hamburger” menu (☰) in the top-left corner.
- Go to “Terminal” > “New Terminal”.
Run the Sync Commands: In the terminal, you will now run a series of Git commands.
- Add base as a remote (if you haven’t already): This tells Git where to find the attogram/base repository.
```
git remote add base https://github.com/attogram/base.git
```
- Fetch and merge base: This downloads the base repository and merges it into your project.
```
git fetch base
git merge base/main
```
Handle Merge Conflicts: If there are any merge conflicts, the Codespace will highlight the affected files in the file browser.
- Click on a conflicted file to open it.
- The editor will show you the conflicting changes with markers (<<<<<<<, =======, >>>>>>>).
- You can use the buttons provided by the editor (“Accept Current Change”, “Accept Incoming Change”, etc.) to resolve the conflicts.
- Once you have resolved the conflicts in a file, save it.
Commit and Push the Changes:
- Go to the “Source Control” tab on the left-hand side (it looks like a branching icon).
- Enter a commit message (e.g., “Sync with attogram/base”).
- Click the checkmark icon to commit the changes.
- Click the “Sync Changes” button to push the changes to your repository on GitHub.
Create a Pull Request:
- Go back to your repository’s main page on GitHub.
- You will see a notification to create a Pull Request from your recently pushed changes.
- Click on it, review the details, and create the PR.

Advanced Method: Using the Command Line

This method is for users who are comfortable with the command line and have Git installed on their local machine.

1. Add `base` as a Remote (if you haven’t already)

First, you need to add the base repository as a remote to your local Git repository. This allows you to fetch its branches and history.

Open your terminal, navigate to your project’s root directory, and run the following command:

git remote add base https://github.com/attogram/base.git

2. Fetch and Merge `base`

Next, fetch the base repository’s history and merge its main branch into your project’s main branch.

git fetch base
git merge base/main

3. Handle Merge Conflicts

It is highly likely that you will encounter merge conflicts. To resolve them:

Identify Conflicting Files: Run git status to see a list of files with conflicts.
Open the Files: Open each conflicting file in your code editor and resolve the conflicts by editing the file and removing the conflict markers (<<<<<<<, =======, >>>>>>>).
Stage the Resolved Files: After resolving the conflicts, stage the files using git add.
```
git add .
```
Commit the Merge: Once all conflicts are resolved, commit the merge.
```
git commit
```

4. Create a Pull Request

After the merge is complete, push the changes to your repository and create a Pull Request.

Push Your Branch:
```
git push origin your-branch-name
```
Open a Pull Request: Go to your repository on GitHub. You will see a prompt to create a new Pull Request. Click on it, fill out the details, and create the PR.

Alternative: Copying Files

If you only want to incorporate a small part of the base repository, like a specific workflow or configuration file, you can simply copy and paste it into your own project.

For example, you can copy the contents of the .github/ directory to get the latest GitHub Actions workflows.

This method is simpler than a full merge, but you will need to manually update the files if you want to get future updates from base.

This site is open source. Improve this page.