github/XHS_Downloader
1
0
Fork 0
mirror of https://github.com/JoeanAmier/XHS-Downloader.git synced 2025-12-26 04:48:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(README.md): 添加贡献指南

Browse Source
This commit is contained in:
JoeanAmier 2025-01-08 23:15:09 +08:00
parent 8f87bb4e5a
commit c20778c2e8
3 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/Manually_docker_image.yml vendored
View File

@ -41,5 +41,5 @@ jobs:
platforms: linux/amd64,linux/arm64
push: true
tags: |
${{ secrets.DOCKERHUB_USERNAME }}/xhs-downloader:${{ github.event.release.tag_name }}
${{ secrets.DOCKERHUB_USERNAME }}/xhs-downloader:${{ env.LATEST_TAG }}
${{ secrets.DOCKERHUB_USERNAME }}/xhs-downloader:latest

10
README.md
View File

@ -410,6 +410,16 @@ async def example():
</tbody>
</table>
<p>如果您愿意，可以考虑提供资助为 <b>XHS-Downloader</b> 提供额外的支持！</p>
<h1 id="contribute">🌟 贡献指南(Contribute)</h1>
<p><strong>非常感谢您对本项目的兴趣！以下是一些指南，帮助您更好地为本项目做出贡献！</strong></p>
<ul>
<li>请在修改代码时，确保相关代码和文件保持最新。</li>
<li>如果您有多个不相互依赖的更改，建议将它们分开提交为独立的拉取请求，以便更好地审查和管理。</li>
<li>请确保您的代码符合项目的风格规范，以保持代码的一致性和可读性。</li>
<li>提交信息应简洁明了，并遵循项目的提交规范。良好的提交信息有助于团队成员理解更改的目的和背景。</li>
<li>拉取请求应该优先考虑合并到 <code>develop</code> 分支，而不是主分支。</li>
</ul>
<p>参考资料：<a href="https://opensource.guide/zh-hans/how-to-contribute/">如何为开源做贡献</a></p>
<h1>✉️ 联系作者</h1>
<ul>
<li>作者邮箱：yonglelolu@foxmail.com</li>

10
README_EN.md
View File

@ -432,6 +432,16 @@ async def example():
</tbody>
</table>
<p>If you are willing, you may consider making a donation to provide additional support for <b>XHS-Downloader</b>!</p>
<h1 id="contribute">🌟 Contributing Guide</h1>
<p><strong>Thank you so much for your interest in this project! Below are some guidelines to help you contribute more effectively to the project.</strong></p>
<ul>
<li>Please ensure that the relevant code and files are kept up-to-date when modifying the code.</li>
<li>If you have multiple independent changes, it is recommended to submit them as separate pull requests to facilitate better review and management.</li>
<li>Ensure your code adheres to the project's style guidelines to maintain consistency and readability.</li>
<li>Commit messages should be clear and concise, following the project's commit message guidelines. Good commit messages help team members understand the purpose and context of changes.</li>
<li>Pull requests should be prioritized to merge into the <code>develop</code> branch rather than the main branch.</li>
</ul>
<p>Reference: <a href="https://opensource.guide/zh-hans/how-to-contribute/">How to Contribute to Open Source</a></p>
<h1>✉️ Contact the Author</h1>
<ul>
<li>Author's Email：yonglelolu@foxmail.com</li>