Features/Sugar3 Docs/How To Write: Difference between revisions
m →Syntax Information: Fix formatting of newlines Tag: visualeditor |
Add a note about adding the doc label Tag: visualeditor-switched |
||
| Line 1: | Line 1: | ||
This will guide your through how to write docs for a module in sugar3. There are 5 easy steps to writing the documentation, and | 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 | ||
| Line 80: | Line 80: | ||
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 = | ||