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

环境：

LLMB项目
题目形貌：

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

解决方案：

步骤 1: 预备本地项目

• 确保项目整洁
  
  
  
  • 确认所有的文件都在符合的位置，并且项目标 README.md 文件已经完善。
    
  • 查抄是否有敏感信息（如API密钥、密码等）不应包含在仓库中，并将其从版本控制系统中移除或利用环境变量替换。
    
    
    
    
  
  
• 初始化 Git 仓库
  假如还没有初始化 Git 仓库，请在项目标根目录下运行以下命令：
  
  1. git init

  复制代码

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

1. # Byte-compiled / optimized / DLL files
2. __pycache__/
3. *.py[cod]
4. *$py.class
6. # Distribution / packaging
7. .Python
8. build/
9. develop-eggs/
10. dist/
11. downloads/
12. eggs/
13. .eggs/
14. lib/
15. lib64/
16. parts/
17. sdist/
18. var/
19. wheels/
20. pip-wheel-metadata/
21. share/python-wheels/
22. *.egg-info/
23. .installed.cfg
24. *.egg
25. MANIFEST
27. # PyInstaller
28. # Usually these files are written by pyinstaller, but in case you change a source file
29. # and then rerun pyinstaller you want to make sure to remove the cached byte-compiled
30. # files.
31. *.pyo
32. # You can skip this if you're not worried about accidentally clobbering files
33. # that are managed by a VCS or if you want to manage the cache yourself.
34. __pycache__/
36. # Installer logs
37. pip-log.txt
38. pip-delete-this-directory.txt
40. # Unit test / coverage reports
41. htmlcov/
42. .tox/
43. .nox/
44. .coverage
45. .coverage.*
46. .cache
47. nosetests.xml
48. coverage.xml
49. *.cover
50. .hypothesis/
51. .pytest_cache/
53. # Translations
54. *.mo
55. *.pot
57. # Django stuff:
58. *.log
59. local_settings.py
60. db.sqlite3
61. db.sqlite3-journal
63. # Flask stuff:
64. instance/
65. .webassets-cache
67. # Scrapy stuff:
68. .scrapy
70. # Sphinx documentation
71. docs/_build/
72. doc/_build/
74. # PyBuilder
75. target/
77. # Jupyter Notebook
78. .ipynb_checkpoints
80. # IPython
81. profile_default/
82. ipython_config.py
84. # pyenv
85. .python-version
87. # pipenv
88. #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89. #   However, in case of collaboration, if having platform-specific dependencies or dependencies
90. #   having no cross-platform support, pipenv may install dependencies that don't work, or not
91. #   install all needed dependencies.
92. #Pipfile.lock
94. # PEP 582; used by e.g. github.com/David-OConnor/pyflow
95. __pypackages__/
97. # Celery stuff
98. celerybeat-schedule
99. celerybeat.pid
101. # SageMath parsed files
102. *.sage.py
104. # Environments
105. .env
106. .venv
107. env/
108. venv/
109. ENV/
110. env.bak/
111. venv.bak/
113. # Spyder project settings
114. .spyderproject
115. .spyproject
117. # Rope project settings
118. .ropeproject
120. # mkdocs documentation
121. /site
123. # mypy
124. .mypy_cache/
125. .dmypy.json
126. dmypy.json
128. # Pyre type checker
129. .pyre/
131. # pytype static type analyzer
132. .pytype/
134. # Cython debug symbols
135. cython_debug/

复制代码

• 提交初始更改
  添加所有文件到暂存区并进行初次提交：
  

添加账号

1. git config --global user.email "lihua@example.com"
2. git config --global user.name "Li Hua"

复制代码

1.   git add .
2.   git commit -m "Initial commit"

复制代码

步骤 2: 创建 GitHub 仓库

• 登录 GitHub
  访问 GitHub 并利用您的账号登录。
  
• 新建仓库
  点击页面右上角的“+”号，然后选择“New repository”。
  
  
  
  
• 填写仓库信息
  
  
  
  • Repository name: 输入仓库名称，比如 LLMB
    
  • Description: 可选地提供简短形貌。
    
  • Public/Private: 选择公开或私有（假如您打算开源，通常选择公开）。
    
  • 不要勾选“Initialize this repository with a README”，因为我们已经在本地预备好了 README 文件。
    
  
  
• 点击 Create repository
  

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

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

  复制代码
• 推送代码到 GitHub
  利用以下命令将本地分支推送到 GitHub：
  
  1. git push -u origin master

  复制代码

完成

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

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

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

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

复制代码

• 创建 CONTRIBUTING.md
  编写一份 CONTRIBUTING.md 文件，指导其他开发者如作甚项目做出贡献。内容可以包罗如何报告题目、提交 Pull Request 的流程等。
  
• 更新 README.md
  确保 README.md 包含足够的信息让用户了解项目标目标、安装方法、利用说明以及如何到场开发。
  
• 提交这些文件
  再次提交这些重要的文档文件：
  
  1. git add .
  2. git commit -m "Add LICENSE and CONTRIBUTING.md"
  3. git push origin main

  复制代码

步骤 5: 公布项目

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

发布版本，新进tag

• 推广项目
  分享您的 GitHub 仓库链接到社交媒体、技能论坛大概相关社区，让更多的人知道您的项目。
  

通过以上步骤，您的项目就已经成功开源并在 GitHub 上发布了！
https://github.com/latiaoge/LLMB.git

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。