如何将自己本地项目开源到github上？

环境：

LLMB项目

问题描述：

如何将自己本地项目开源到github上？

解决方案：

步骤 1: 准备本地项目

1. 确保项目整洁

   • 确认所有的文件都在合适的位置，并且项目的 README.md 文件已经完善。
   • 检查是否有敏感信息（如API密钥、密码等）不应包含在仓库中，并将其从版本控制系统中移除或使用环境变量替代。
     

2. 初始化 Git 仓库
   如果还没有初始化 Git 仓库，请在项目的根目录下运行以下命令：

   git init
   

3. 添加 .gitignore 文件
   创建一个 .gitignore 文件来指定哪些文件或目录不应该被跟踪。您可以根据项目的技术栈选择合适的模板。例如，对于 Python 项目，可以参考 GitHub 的 Python.gitignore。

# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
pip-wheel-metadata/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST# PyInstaller
# Usually these files are written by pyinstaller, but in case you change a source file
# and then rerun pyinstaller you want to make sure to remove the cached byte-compiled
# files.
*.pyo
# You can skip this if you're not worried about accidentally clobbering files
# that are managed by a VCS or if you want to manage the cache yourself.
__pycache__/# Installer logs
pip-log.txt
pip-delete-this-directory.txt# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/# Translations
*.mo
*.pot# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal# Flask stuff:
instance/
.webassets-cache# Scrapy stuff:
.scrapy# Sphinx documentation
docs/_build/
doc/_build/# PyBuilder
target/# Jupyter Notebook
.ipynb_checkpoints# IPython
profile_default/
ipython_config.py# pyenv
.python-version# pipenv
#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
#   However, in case of collaboration, if having platform-specific dependencies or dependencies
#   having no cross-platform support, pipenv may install dependencies that don't work, or not
#   install all needed dependencies.
#Pipfile.lock# PEP 582; used by e.g. github.com/David-OConnor/pyflow
__pypackages__/# Celery stuff
celerybeat-schedule
celerybeat.pid# SageMath parsed files
*.sage.py# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/# Spyder project settings
.spyderproject
.spyproject# Rope project settings
.ropeproject# mkdocs documentation
/site# mypy
.mypy_cache/
.dmypy.json
dmypy.json# Pyre type checker
.pyre/# pytype static type analyzer
.pytype/# Cython debug symbols
cython_debug/

4. 提交初始更改

   添加所有文件到暂存区并进行首次提交：

添加账号

 git config --global user.email "[e-mail]"
git config --global user.name "Li Hua"

  git add .git commit -m "Initial commit"

步骤 2: 创建 GitHub 仓库

1. 登录 GitHub
   访问 GitHub 并使用您的账号登录。

2. 新建仓库
   点击页面右上角的“+”号，然后选择“New repository”。
   

3. 填写仓库信息

   • Repository name: 输入仓库名称，比如 LLMB
   • Description: 可选地提供简短描述。
   • Public/Private: 选择公开或私有（如果您打算开源，通常选择公开）。
   • 不要勾选“Initialize this repository with a README”，因为我们已经在本地准备好了 README 文件。

4. 点击 Create repository

步骤 3: 将本地仓库推送到 GitHub

1. 关联远程仓库
   在本地终端中，将本地仓库与新创建的 GitHub 仓库关联起来。用您刚刚创建的 GitHub 仓库 URL 替换下面的 <your-github-repo-url>：

   git remote add origin <your-github-repo-url>
   

2. 推送代码到 GitHub
   使用以下命令将本地分支推送到 GitHub：

   git push -u origin master
   

完成

步骤 4: 配置许可证和贡献指南

1. 添加 LICENSE 文件
   如果还没有添加许可证文件，请创建一个 LICENSE 文件并选择适当的开源许可证。GitHub 提供了多种许可证的选择，可以在 Choose an open source license 上找到更多信息。
   使用 GitHub 自动生成

如果您已经创建了 GitHub 仓库并且正在初始化或编辑 README 文件，GitHub 会提示您添加许可证。这是最简单的方法之一：

在 GitHub 上进入您的仓库页面。
点击页面右上角的“Add file”按钮，然后选择“Create new file”。
在文件名中输入 LICENSE 或 LICENSE.md。
GitHub 会检测到这是一个许可证文件，并提供一个下拉菜单让您选择许可证。
选择您想要的许可证，GitHub 会自动生成相应的文本。
添加提交信息并点击“Commit new file”。

2. 创建 CONTRIBUTING.md
   编写一份 CONTRIBUTING.md 文件，指导其他开发者如何为项目做出贡献。内容可以包括如何报告问题、提交 Pull Request 的流程等。

3. 更新 README.md
   确保 README.md 包含足够的信息让用户了解项目的目的、安装方法、使用说明以及如何参与开发。

4. 提交这些文件
   再次提交这些重要的文档文件：

   git add .
   git commit -m "Add LICENSE and CONTRIBUTING.md"
   git push origin main
   

步骤 5: 公布项目

1. 设置 GitHub Pages（可选）
   如果您希望为项目创建一个网站，可以通过 GitHub Pages 来实现。这可以让用户更容易访问到项目的文档和演示。

发布版本，新进tag

2. 推广项目
   分享您的 GitHub 仓库链接到社交媒体、技术论坛或者相关社区，让更多的人知道您的项目。

通过以上步骤，您的项目就已经成功开源并在 GitHub 上发布了！

https://github.com/latiaoge/LLMB.git