Commit Digest/Editor guidelines: Difference between revisions
(moved some comments from Danny) |
(Major filling in of this page. Initial complete page, old information worked in.) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
* In the synopsis, most important items go first, moves / deletions / tagging / releases / miscellaneous at bottom. Also, try and group items where they make sense (eg. mentions of KOffice stuff can be followed by Calligra / Skrooge / etc items) | [[Commit Digest| << back]] | ||
* | |||
==Some Guidelines== | |||
* In any mentions of the publication, always either '''KDE Commit-Digest''', '''Commit-Digest''', or '''Digest''' (note the capitalisation and hyphenation) | |||
==Writing the Synopsis== | |||
===Scan the bug fixes=== | |||
Note down any application that received a significant number (3+, sometimes 2+ if good). Keep an eye out for features hidden in the bugfixes (example: Calligra has a number of DOC and PPD related fixes, thus the feature is increased DOC and PPD support) | |||
From this, you can create the ending sentence. Example: "Bugfixing in Plasma, Dolphin, NetworkManagement, KWin, and KMyMoney." | |||
===Read through the features section=== | |||
Copy in the significant entries into the synopsis. Reword commits to be understandable. If the application also had significant bugfixes, mention both in the same sentence and remove it from "Bugfixing in..". | |||
===Link up each application/project to it's homepage=== | |||
ex: its own site, project page on kde.org, edu.kde.org page, userbase.kde.org page, community.kde.org page, or a blog entry from it's author if it has no official location on the web. Use your own jurisdiction for which is best. Clicking "Add Links" should do most of this work for you. | |||
===Notes=== | |||
*1 application/project per sentence, except for the ending "bugfixing in..." sentence. | |||
*Loosely organize sentence hierarchy based on significance of changes. Most important items go first, moves / deletions / tagging / releases / miscellaneous at bottom. Also, try and group items where they make sense (eg. mentions of KOffice stuff can be followed by Calligra / Skrooge / etc items) | |||
*Each application/project must be capitalized like so: KDE-PIM, KDevPlatform, KWin, NetworkManagement, Dolphin, Telepathy-Presence-Applet, OwnCloud, etc. | |||
*It is up to you how verbose you would like to be about the week's changes, but if your time is short, I would recommend at least 5-6 sentences plus a "bugfixing in.." sentence --[[User:Vblanton|Vblanton]] 18:51, 8 June 2011 (UTC). | |||
== Introduction Section == | |||
Is there a feature article ready for inclusion in the issue? Scroll down to "Introduction" and click "Insert from features..." Pick the article that is ready. Then, make sure to reference that there is an article in the Dot Synopsis submittal later on. (ex: "This week, the Commit Digest includes a featured article about Kst, the fastest real-time large-dataset viewing and plotting tool."). | |||
The first mention of a program should be hyperlinked to the project site (e.g. <a href="http://koffice.org/">KOffice</a>) | |||
== Publish the digest == | |||
change Published to "yes" | |||
== Send the story to the Dot == | |||
Click Dot Synopsis, go to dot.kde.org, click "Contribute a Story" and copy the information in. You may need to register for a username on the Dot if you have not done so already. | |||
All done! | |||
Have fun! | |||
==Example Digest== | |||
===Digest 186 from 5th June 2011=== | |||
[http://commit-digest.org/issues/2011-06-05/] | |||
Work on C++0x support in KDevelop, including support for variadic template parameters in the parser, new browser-like tabs, and many bugfixes throughout KDevPlatform. In Plasma, suspend/hibernate services added to the powermanagement dataengine, battery applet replaced with QML port from Plasma-Mobile, and many bugfixes. Work on Xlsx, DOC, and VML support in Calligra, along with support for baseline shift, a new preset chooser widget in Krita, initial commit of the Krita Animator plugin, and much bugfixing. Further bugfixing and work on NM09 support in NetworkManagement including manual setting of speed and duplex mode for ethernet and advanced permission settings. Work on Kartesio to support scientific notation. Finishing work on Cantor's Scilab backend. GSOC work on making the canvas use the new QGraphicsView in Umbrello. Oxidization data added to elements in Kalzium. GSOC work on Commit Dialog in Dolphin, amongst further bugfixing. Start of javascript API support in Share-Like-Connect, amongst other work. Further work on Telepathy-Presence-Applet. More work on IM icons in Oxygen. Improved file uploader and work on the media player in OwnCloud. Use of Qt gesture framework in Marble. Bugfixing in Konqueror, KWin, KDE-PIM, KMyMoney, Amarok, and Juk. | |||
===the html:=== | |||
Work on C++0x support in <a href="http://www.kdevelop.org/">KDevelop</a>, including support for variadic template parameters in the parser, new browser-like tabs, and many bugfixes throughout KDevPlatform. In <a href="http://plasma.kde.org/">Plasma</a>, suspend/hibernate services added to the powermanagement dataengine, battery applet replaced with QML port from <a href="http://community.kde.org/Plasma/Plasma-Mobile">Plasma-Mobile</a>, and many bugfixes. Work on Xlsx, DOC, and VML support in <a href="http://www.calligra-suite.org/">Calligra</a>, along with support for baseline shift, a new preset chooser widget in <a href="http://krita.org/">Krita</a>, initial commit of the Krita Animator plugin, and much bugfixing. Further bugfixing and work on NM09 support in <a href="http://userbase.kde.org/NetworkManagement">NetworkManagement</a> including manual setting of speed and duplex mode for ethernet and advanced permission settings. Work on Kartesio to support scientific notation. Finishing work on <a href="http://edu.kde.org/cantor/">Cantor's</a> Scilab backend. GSOC work on making the canvas use the new QGraphicsView in <a href="http://uml.sourceforge.net/">Umbrello</a>. Oxidization data added to elements in <a href="http://edu.kde.org/kalzium/">Kalzium</a>. GSOC work on Commit Dialog in <a href="http://dolphin.kde.org/">Dolphin</a>, amongst further bugfixing. Start of javascript API support in <a href="http://ivan.fomentgroup.org/blog/2011/06/06/contouring-the-share-like-connect/">Share-Like-Connect</a>, amongst other work. Further work on <a href="http://community.kde.org/Real-Time_Communication_and_Collaboration">Telepathy-Presence-Applet</a>. More work on IM icons in <a href="http://www.oxygen-icons.org/">Oxygen</a>. Improved file uploader and work on the media player in <a href="http://owncloud.org/">OwnCloud</a>. Use of Qt gesture framework in <a href="http://edu.kde.org/marble/">Marble</a>. Bugfixing in <a href="http://www.konqueror.org/">Konqueror</a>, <a href="http://userbase.kde.org/KWin">KWin</a>, <a href="http://community.kde.org/KDE_PIM">KDE-PIM</a>, <a href="http://kmymoney2.sourceforge.net/">KMyMoney</a>, <a href="http://amarok.kde.org/">Amarok</a>, and <a href="http://userbase.kde.org/Juk">Juk</a>. | |||
Latest revision as of 18:51, 8 June 2011
Some Guidelines
- In any mentions of the publication, always either KDE Commit-Digest, Commit-Digest, or Digest (note the capitalisation and hyphenation)
Writing the Synopsis
Scan the bug fixes
Note down any application that received a significant number (3+, sometimes 2+ if good). Keep an eye out for features hidden in the bugfixes (example: Calligra has a number of DOC and PPD related fixes, thus the feature is increased DOC and PPD support)
From this, you can create the ending sentence. Example: "Bugfixing in Plasma, Dolphin, NetworkManagement, KWin, and KMyMoney."
Read through the features section
Copy in the significant entries into the synopsis. Reword commits to be understandable. If the application also had significant bugfixes, mention both in the same sentence and remove it from "Bugfixing in..".
Link up each application/project to it's homepage
ex: its own site, project page on kde.org, edu.kde.org page, userbase.kde.org page, community.kde.org page, or a blog entry from it's author if it has no official location on the web. Use your own jurisdiction for which is best. Clicking "Add Links" should do most of this work for you.
Notes
- 1 application/project per sentence, except for the ending "bugfixing in..." sentence.
- Loosely organize sentence hierarchy based on significance of changes. Most important items go first, moves / deletions / tagging / releases / miscellaneous at bottom. Also, try and group items where they make sense (eg. mentions of KOffice stuff can be followed by Calligra / Skrooge / etc items)
- Each application/project must be capitalized like so: KDE-PIM, KDevPlatform, KWin, NetworkManagement, Dolphin, Telepathy-Presence-Applet, OwnCloud, etc.
- It is up to you how verbose you would like to be about the week's changes, but if your time is short, I would recommend at least 5-6 sentences plus a "bugfixing in.." sentence --Vblanton 18:51, 8 June 2011 (UTC).
Introduction Section
Is there a feature article ready for inclusion in the issue? Scroll down to "Introduction" and click "Insert from features..." Pick the article that is ready. Then, make sure to reference that there is an article in the Dot Synopsis submittal later on. (ex: "This week, the Commit Digest includes a featured article about Kst, the fastest real-time large-dataset viewing and plotting tool."). The first mention of a program should be hyperlinked to the project site (e.g. <a href="http://koffice.org/">KOffice</a>)
Publish the digest
change Published to "yes"
Send the story to the Dot
Click Dot Synopsis, go to dot.kde.org, click "Contribute a Story" and copy the information in. You may need to register for a username on the Dot if you have not done so already.
All done!
Have fun!
Example Digest
Digest 186 from 5th June 2011
Work on C++0x support in KDevelop, including support for variadic template parameters in the parser, new browser-like tabs, and many bugfixes throughout KDevPlatform. In Plasma, suspend/hibernate services added to the powermanagement dataengine, battery applet replaced with QML port from Plasma-Mobile, and many bugfixes. Work on Xlsx, DOC, and VML support in Calligra, along with support for baseline shift, a new preset chooser widget in Krita, initial commit of the Krita Animator plugin, and much bugfixing. Further bugfixing and work on NM09 support in NetworkManagement including manual setting of speed and duplex mode for ethernet and advanced permission settings. Work on Kartesio to support scientific notation. Finishing work on Cantor's Scilab backend. GSOC work on making the canvas use the new QGraphicsView in Umbrello. Oxidization data added to elements in Kalzium. GSOC work on Commit Dialog in Dolphin, amongst further bugfixing. Start of javascript API support in Share-Like-Connect, amongst other work. Further work on Telepathy-Presence-Applet. More work on IM icons in Oxygen. Improved file uploader and work on the media player in OwnCloud. Use of Qt gesture framework in Marble. Bugfixing in Konqueror, KWin, KDE-PIM, KMyMoney, Amarok, and Juk.
the html:
Work on C++0x support in <a href="http://www.kdevelop.org/">KDevelop</a>, including support for variadic template parameters in the parser, new browser-like tabs, and many bugfixes throughout KDevPlatform. In <a href="http://plasma.kde.org/">Plasma</a>, suspend/hibernate services added to the powermanagement dataengine, battery applet replaced with QML port from <a href="http://community.kde.org/Plasma/Plasma-Mobile">Plasma-Mobile</a>, and many bugfixes. Work on Xlsx, DOC, and VML support in <a href="http://www.calligra-suite.org/">Calligra</a>, along with support for baseline shift, a new preset chooser widget in <a href="http://krita.org/">Krita</a>, initial commit of the Krita Animator plugin, and much bugfixing. Further bugfixing and work on NM09 support in <a href="http://userbase.kde.org/NetworkManagement">NetworkManagement</a> including manual setting of speed and duplex mode for ethernet and advanced permission settings. Work on Kartesio to support scientific notation. Finishing work on <a href="http://edu.kde.org/cantor/">Cantor's</a> Scilab backend. GSOC work on making the canvas use the new QGraphicsView in <a href="http://uml.sourceforge.net/">Umbrello</a>. Oxidization data added to elements in <a href="http://edu.kde.org/kalzium/">Kalzium</a>. GSOC work on Commit Dialog in <a href="http://dolphin.kde.org/">Dolphin</a>, amongst further bugfixing. Start of javascript API support in <a href="http://ivan.fomentgroup.org/blog/2011/06/06/contouring-the-share-like-connect/">Share-Like-Connect</a>, amongst other work. Further work on <a href="http://community.kde.org/Real-Time_Communication_and_Collaboration">Telepathy-Presence-Applet</a>. More work on IM icons in <a href="http://www.oxygen-icons.org/">Oxygen</a>. Improved file uploader and work on the media player in <a href="http://owncloud.org/">OwnCloud</a>. Use of Qt gesture framework in <a href="http://edu.kde.org/marble/">Marble</a>. Bugfixing in <a href="http://www.konqueror.org/">Konqueror</a>, <a href="http://userbase.kde.org/KWin">KWin</a>, <a href="http://community.kde.org/KDE_PIM">KDE-PIM</a>, <a href="http://kmymoney2.sourceforge.net/">KMyMoney</a>, <a href="http://amarok.kde.org/">Amarok</a>, and <a href="http://userbase.kde.org/Juk">Juk</a>.