/OpenCopilot

🤖 🔥 AI Copilot for your own SaaS product. Open source AI sidekick for everyone.

Primary LanguageTypeScriptMIT LicenseMIT

Developer Guide

Welcome to the OpenCopilotCloud repository, a private version of the OpenCopilot project. This guide will walk you through the basics of working with this repository, including how to push changes and keep it synchronized with the original OpenCopilot repo.

Cloning the Repository

To start working with the OpenCopilotCloud repository, clone it to your local machine:

git clone https://github.com/openchatai/OpenCopilotCloud.git
cd OpenCopilotCloud

Configuring Remotes

Since this repository is intended to stay in sync with the OpenCopilot original repo, set up an additional remote named upstream:

git remote add upstream https://github.com/openchatai/OpenCopilot.git

Now, your repository is connected to both the private (origin) and the original public (upstream) repositories.

Making Changes

When you're ready to make changes:

  1. Create a new branch:
    git checkout -b feature/your-feature-name
  2. Make your changes in the code.
  3. Commit your changes:
    git add .
    git commit -m "Describe your changes here"
  4. Push your branch to the private repository:
    git push origin feature/your-feature-name

Updating From the Original Repository

To keep your private repository updated with changes from the OpenCopilot repository:

  1. Fetch the latest changes from the original repo:
    git fetch upstream
  2. Merge the changes into your desired branch:
    git checkout your-branch
    git merge upstream/main
  3. Resolve any merge conflicts if they arise.

Best Practices

  • Regularly pull updates from the upstream to stay synchronized with the original repository.
  • Always work on a new branch for each feature or fix, rather than directly on the master branch.
  • Before pushing your changes, rebase if necessary to maintain a clean commit history.