CONTRIBUTING.md
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 20/100
- Issue 類型
- 文件
- 描述清晰度
- 需要釐清
- 活躍度
- 停滯
- 技術堆疊
- markdown
研究方向
該 issue 提供了 CONTRIBUTING.md 的內容,但沒有明確要求的變更、目標章節或驗收標準。先檢視目前的 CONTRIBUTING.md 和儲存庫狀態,然後釐清需要更新哪些文件,以及如何驗證結果。
由索引模型根據 Issue 內容生成。
描述
Contributing to training-kit
🎉 Thank you for taking the time to contribute and for seeking out these instructions. We ❤️ community contributions to these materials.
Code of Conduct
This project and everyone who participates in it is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
What should I know before I get started?
The goal of these resources
These materials are designed to help those new to Git, GitHub and software development as a whole. By using these materials, we hope users will:
- Feel welcome and become active contributors in the open source community
- Learn best practices for using Git and GitHub
- Learn how to use the applications within GitHub's ecosystem to build better software
Types of contributions we love
We're always looking for contributions to help improve these resources. This includes:
- Improving the existing cheat sheets
- Translations of existing cheat sheets into new languages
- Adding new courseware or resources aligned with the goals
How to contribute
Report a bug
Oops, thanks for finding that! If you know how to fix it, please feel free to fork the repository and submit a change via Pull Request.
If you aren't sure how to fix it or just don't have time, we invite you to open a new Issue. Please be sure to provide information, so we can recreate the error.
Translate existing resources
Several community members have been kind enough to translate the Git Cheat Sheets into various languages. At this time, we are only set up to serve the cheat sheets in various languages (but maybe you can help us change that 😉). If you are planning to contribute a translation, please do the following:
- Fork this repository
- Create a new folder in the downloads directory using the standard abbreviation for the language you are providing.
- Copy the most recent English version of the cheat sheet to the folder you created.
- Complete the translation
- Add a link to the translated resource on /index.html
- Open a pull request against the
mainbranch of this repository. - Be sure to @ mention a couple of your friends who are native speakers and ask them to review the translation.
- Update your translation based on feedback from your friends.
When this process is complete, we will be happy to merge the completed document.
Contribute something new
Whether you have an idea to make it better, or want to contribute a whole new course or resource ... we ❤️ new ideas! We invite you to open a new Issue to talk about it before you invest too much time. Of course, if you want to experiment first, you can fork this repository and submit your idea via a Pull Request.
When you are contributing something new, we ask you to be familiar with our content philosophy, the structure of the repository, and building Jekyll sites locally. See the sections below for more information.
Not sure where to start?
If you just want to help out, but don't have a particular change in mind, check out the open issues for projects you can tackle, review an open pull request, or check out the project ROADMAP.
Styling content
This site uses GitHub's CSS toolkit called Primer. It's easy to use, and if your contribution requires some design or front-end work you should check out the Primer Docs.
For writing style guides, we lean on the GitHub Brand Guide. The Content section is a great place to start.
Building and testing
When you are ready to test your changes, you will want to build the repository locally. This is fully automated through a series of shell scripts based the scripts to rule them all!
To build the materials do the following:
- Run
script/bootstrapto install the dependencies - Run
script/buildto build the site - Run
script/server- When successful, the script will initiate a local server at
http://127.0.0.1:4000/.
- When successful, the script will initiate a local server at
- Simply paste that into your favorite web-browser, and you will be ready to test
- 主要語言
- HTML
- 星號
- 5.1k
- 分支
- 4.5k
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
github/training-kit 的其他 Issue
-
難度 1/5 1 小時以內 新手友好度 65/100
github/training-kit#1163 · 1 則留言 · 1 個 reaction ·
-
test issue未關閉
難度 5/5 一週以上 新手友好度 1/100
github/training-kit#1196 · 1 則留言 ·
-
V未關閉
難度 5/5 一週以上 新手友好度 10/100
github/training-kit#1193 ·
-
A未關閉
難度 5/5 一週以上 新手友好度 10/100
github/training-kit#1189 ·
-
Q未關閉
難度 5/5 一週以上 新手友好度 10/100
github/training-kit#1188 ·
查看 github/training-kit 的全部 Issue
相似的 Issue
-
documentation glm5 llm-model
難度 2/5 1-3 小時 新手友好度 78/100
vllm-project/vllm-ascend#19062 ·
維護者通常 1 天內回覆
-
難度 1/5 1-3 小時 新手友好度 78/100
tursodatabase/turso#10052 ·
維護者通常 1 天內回覆
-
Mac mini M6 (16 GB): Q2_0 streaming works - measured 11.7->27.2 tok/s + arena fix for sub-32 GB Macs未關閉
難度 2/5 1-3 小時 新手友好度 68/100
維護者通常 1 天內回覆
-
enhancement needs triage
難度 2/5 1-3 小時 新手友好度 70/100
elastic/docs-builder#4495 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 74/100
cellrishi-code/claude-skills-atlas#165 ·
維護者通常 1 天內回覆