Skip to content

Latest commit

 

History

History
71 lines (50 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

71 lines (50 loc) · 2.16 KB
Raw

Contributing

Request for changes/ Pull Requests

You first need to create a fork of the vitejs-chat-gpt-open-ai repository to commit your changes to it. Methods to fork a repository can be found in the GitHub Documentation.

Then add your fork as a local project:

# Using HTTPS
git clone https://github.com/trinhminhnhat/vitejs-chat-gpt-open-ai.git

# Using SSH
git clone [email protected]:trinhminhnhat/vitejs-chat-gpt-open-ai.git

Which remote URL should be used ?

Then, go to your local folder

cd vitejs-chat-gpt-open-ai

Add git remote controls:

# Using HTTPS
git remote add fork https://github.com/YOUR-USERNAME/vitejs-chat-gpt-open-ai.git
git remote add upstream https://github.com/trinhminhnhat/vitejs-chat-gpt-open-ai.git


# Using SSH
git remote add fork [email protected]:YOUR-USERNAME/vitejs-chat-gpt-open-ai.git
git remote add upstream [email protected]/trinhminhnhat/vitejs-chat-gpt-open-ai.git

You can now verify that you have your two git remotes:

git remote -v

Receive remote updates

In view of staying up to date with the central repository :

git pull upstream main

Choose a base branch

Before starting development, you need to know which branch to base your modifications/additions on. When in doubt, use main.

Type of change Branches
Documentation main
Bug fixes main
New features main
New issues models YOUR-USERNAME:patch 
# Switch to the desired branch
git switch main

# Pull down any upstream changes
git pull

# Create a new branch to work on
git checkout -b patch/1-name-issue

Commit your changes, then push the branch to your fork with git push -u fork and open a pull request on the vitejs-chat-gpt-open-ai repository following the template provided.