commandlineparser / commandlineparser/commandline

How to contribute to Wiki Documentation

未關閉
#486 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
announcement documentation
主要語言
C#
星號
4.8k
分支
478
PR 合併指標
30 天內沒有已合併 PR

描述

GitHub wikis are just Git repositories. Unfortunately contributors cannot fork the wikis through the GitHub UI, so while they can clone the wiki and make a change to the copy, they cannot submit a pull request.
A relatively easy workaround for this issue is to clone the wiki, do changes and send changes as Git Patches

Welcome to contributers to rich the wiki pages with examples

**How it works**

- Clone wiki documentation

git clone https://github.com/commandlineparser/commandline.wiki.git

- create a new branch, e.g "custome-help"

git checkout -b custome-help

- update/Add wiki pages

git add .
git commit -m "add custome-help.md"

- create Git Patch for your changes

git format-patch master --stdout > custome-page.patch

- Open a new Issue describing what changes in wiki , e.g
Wiki: Add a new custom-page.md page
Attach the patch file "custome-page.patch" as a zip file.

- Project maintainers will review the submitted patch file(s) of the wiki changes and merge it in the wiki Repo.

**Tips for wiki:**

- PR can contain wiki patche(s) for the new feature or fix with code example.
- You can provide code examples as an attached zip file.
- You can use [dotnetfiddle](https://dotnetfiddle.net) to show a working example.
- Review the current open issues related to the documentation and submit a wiki page with examples.

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

從 commandlineparser/commandline.wiki.git 的 repository wiki 開始,檢查 issue 中提出的 clone、branch 和 patch 工作流程。確認專案是否已有文件貢獻指南或未解決的文件 issue。完成的標準是:有一套清楚且持續維護的流程,用於提交 wiki 變更,供 maintainers review 和 merge。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
git
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
需要釐清
新手友好度
25/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。