mirror of https://github.com/danny-avila/LibreChat.git synced 2025-09-22 08:12:00 +02:00

* mkdocs plugins: add plugin for social cards and plugin that allow to exclude a folder

* docs: fix hyperlinks

* mkdocs: social cards (descriptions) for 'contributions' and 'deployment' guides

* mkdocs: social cards (descriptions) for all 'index.md'

* mkdocs: social cards (descriptions) for 'features' and 'plugins'

* mkdocs: social cards (descriptions) for 'general_info'

* mkdocs: social cards (descriptions) for 'configuration'

* mkdocs: social cards (descriptions) for 'installation'

* mkdocs: minor fixes

* update librechat.svg

* update how_to_contribute.md

add reference to the official GitHub documentation

2023-12-28 17:10:06 -05:00

3.6 KiB

Raw Blame History

title	description	weight
🙌 Beginner's Guide to Contributions	Learn how to use GitHub Desktop, VS Code extensions, and Git rebase to contribute in a quick and easy way.	-10

How to Contribute in a Quick and Easy Way

❗Note: If you are not familiar with the concept of repo, PR (pull request), fork and branch, start by looking at the official GitHub documentation on the subject: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models

Installation of Tools

Git is essential, the first thing to download.
Git LFS can be useful for uploading files with larger sizes.
Github Desktop - I use it only for UI; I don't recommend using it for pushing or other actions.

How to Use?

This will be a somewhat raw text, but I'll try to be as clear as possible.

I recommend installing the following extensions in VS Code:

Example of a Pull Request (PR)

Let's say I want to add another page for an API Panel.

Open GitHub and select Danny's fork.
First, make sure that the main branch is clean with no commits and up to date.
Open "View all my branches" and create a new branch with a descriptive name for your task. For example: "ApiPanel."
In GitHub Desktop, select the branch you just created.
Start modifying the code, and when you finish a part, commit the changes. Example of commits:

commit1: Created the frontend
commit2: Fixed a bug in variable export
commit3: Removed unnecessary comments and added translation support
and so on...

Testing

While testing the code, if you're working with the frontend, it might be frustrating to run npm run frontend and npm run backend every time. Instead, use npm run frontend:dev to see real-time changes on port 3090 (really!).

Note: You must run npm run frontend once before you can use npm run frontend:dev

How?

git add * adds all files to be committed.
git commit -m "name-of-your-commit" creates a commit.
git push uploads the changes.

Before doing all this, I recommend using GitHub Desktop to see what you've changed.

If git commit fails due to ESLint errors, read the error message and understand what's wrong. It could be an unused variable or other issues.

Possible Various Problems

If you have the main branch with many commits and don't know what to do, follow this simple guide:

⚠️ Please do this only when you have no active PRs or when you're not working on the project:

Do a pull origin and in the terminal write git log to identify how many commits you are behind.
Use git rebase -i HEAD~2, where 2 represents the number of commits you need to go back. If you need to go back 100 commits, use git rebase -i HEAD~100.
In the editor, change the "pick" for the two commits to "drop," save with "esc," then type :wq and press "Enter."
Finally, run git push --force origin main.

3.6 KiB Raw Blame History