163
edits
Changes
Features/Sugar3 Docs/How To Write (view source)
Revision as of 03:14, 17 November 2015
, 03:14, 17 November 2015Add a note about adding the doc label
This will guide your through how to write docs for a module in sugar3. There are 5 easy steps to writing the documentation, and 2 bonus steps for getting it merged.
This will guide your through how to write docs for a module in sugar3. There are 5 easy steps to writing the documentation, and 3 bonus steps for getting it merged.
Example patch: https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/269/files or https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/256/files
Example patch: https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/269/files or https://github.com/sugarlabs/sugar-toolkit-gtk3/pull/256/files
6. Write a commit message like ''Write documentation for sugar3.i.just.wrote.docs''.
6. Write a commit message like ''Write documentation for sugar3.i.just.wrote.docs''.
7. Listen to whoever reviews your patch.
7. Create a pull request on GitHub, and make sure to add the ''doc'' label while you are making it.
8. Listen to whoever reviews your patch.
= Syntax Information =
= Syntax Information =