commandlineparser / commandlineparser/commandline

How to contribute to Wiki Documentation

Abierto
#486 0 comentarios 0 reacciones 0 asignados Ver en GitHub
announcement documentation
Lenguaje dominante
C#
Estrellas
4.8k
Forks
478
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.