欢迎您对我们的开源技术文档仓库做出贡献!我们非常感谢您的帮助,以下是一些建议和指导,以确保贡献的顺利进行。
您可以通过以下方式贡献:
-
报告问题:发现了文档中的错误或有改进的地方?请创建一个 Issue 来报告问题。
-
提出改进建议:如果您有关于文档结构、内容或样式的建议,请通过 Issue 提出您的想法。
-
提交文档:如果您有自己的技术文档并希望分享,欢迎提交 Pull Request。
-
在我们的 Issues 页面 创建一个新的 Issue。
-
选择相应的标签,例如“bug”或“enhancement”。
-
提供清晰而详细的说明,包括问题的复现步骤(如果是报告问题)或您的建议。
-
Fork 这个仓库并在本地克隆它:
git clone https://gitee.com/TSGU-OSC/ffmpeg_learn.git
-
在合适的目录下创建您的目录并编辑您的md文档 在此以document举例
cd document mkdir your_directory cd your_directory touch README.md vim README.md
-
提交您的修改
git add . git commit -m "Add/modify your-documentation-file.md"
-
推送到您的Fork
git push origin feature/your-feature
-
创建一个 Pull Request(PR):
- 到您的 Fork 页面,点击 "New Pull Request"。
- 选择要将您的修改合并到的目标分支。
- 提供清晰而简洁的 PR 描述。
- 我们将审查您的 PR,并在需要时提出建议或请求修改。
- 请确保您的文档使用正确的 Markdown 语法,并注意格式的一致性。
- 如果您贡献的是新的主题,请在目录中添加相应的链接。
- 我们鼓励包含适当的图片、图表等以提高文档的可读性。如有图片请将图片放入image目录下。