<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"></head><body>
<div>Agreed, note that you can also use the visual changelog as reference when it already released and you are working on the documentation.</div><div><br></div><div>Y.</div><div><br></div><div><br></div><div><br></div><div id="composer_signature"><div style="font-size:88%;color:#364f67" dir="auto">Envoyé depuis mon appareil Samsung</div></div><br><br>-------- Message d'origine --------<br>De : Alexandre Neto <senhor.neto@gmail.com> <br>Date : 07/03/2017 11:21 (GMT+01:00) <br>À : DelazJ <delazj@gmail.com>, Nyall Dawson <nyall.dawson@gmail.com> <br>Cc : qgis-developer <qgis-developer@lists.osgeo.org> <br>Objet : Re: [Qgis-developer] 3.0 Documentation and branching <br><br><p dir="ltr">Totally agree with Harrissou. A good description in the commit with the rigth tags should be enough. </p>
<p dir="ltr">Alex Neto</p>
<br><div class="gmail_quote"><div dir="ltr">A ter, 7/03/2017, 10:06, DelazJ <<a href="mailto:delazj@gmail.com">delazj@gmail.com</a>> escreveu:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr" class="gmail_msg">Hi,<br class="gmail_msg"><div class="gmail_extra gmail_msg"><br class="gmail_msg"><div class="gmail_quote gmail_msg"></div></div></div><div dir="ltr" class="gmail_msg"><div class="gmail_extra gmail_msg"><div class="gmail_quote gmail_msg">2017-03-07 5:58 GMT+01:00 Nyall Dawson <span dir="ltr" class="gmail_msg"><<a href="mailto:nyall.dawson@gmail.com" class="gmail_msg" target="_blank">nyall.dawson@gmail.com</a>></span>:<br class="gmail_msg"><blockquote class="gmail_quote gmail_msg" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><br class="gmail_msg">
<br class="gmail_msg">
I think a better solution is to hook into the current<br class="gmail_msg">
[FEATURE]/[NEEDS-DOCS] hooks which auto-open issues on the<br class="gmail_msg">
documentation repo. We could *require* that all developers who push a<br class="gmail_msg">
new feature commit have to post on the corresponding documentation<br class="gmail_msg">
auto-opened issue with at least very rough notes about how the feature<br class="gmail_msg">
is supposed to work. The documentation team could then polish these<br class="gmail_msg">
up, add screenshots, etc (and merge when the timing is right for the<br class="gmail_msg">
team). This would also keep things as easy as possible for devs so<br class="gmail_msg">
that they (*cough*... i mean me *cough*) have no excuse not to do it!<br class="gmail_msg">
<span class="m_-8188060274305553832HOEnZb gmail_msg"><font color="#888888" class="gmail_msg"><br class="gmail_msg"></font></span></blockquote></div></div></div><div dir="ltr" class="gmail_msg"><div class="gmail_extra gmail_msg"><div class="gmail_quote gmail_msg"><div class="gmail_msg">You are right, Nyall. <br class="gmail_msg">However, I do not think that they later need to add information in the auto-opened issue in Doc repository. By default the generated issue is populated with all the information in the commit. So a really descriptive commit to QGIS repository with those tags should be enough. There are some very good (from a doc writer pov of course) commits where you only need to find the right place in the doc and copy paste the description with minor adjustments. Unfortunately, they are currently far from being the majority. On the other side, there still are many with simply the title (which sometimes can be helpful) or do use a dev language (too much cryptic?).<br class="gmail_msg"><br class="gmail_msg"></div><div class="gmail_msg">Also note that a verbose commit benefits to the Changelog team, when time comes....<br class="gmail_msg"><br class="gmail_msg"></div><div class="gmail_msg">Harrissou<br class="gmail_msg"><br class="gmail_msg"></div><blockquote class="gmail_quote gmail_msg" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><span class="m_-8188060274305553832HOEnZb gmail_msg"><font color="#888888" class="gmail_msg">
Nyall<br class="gmail_msg">
</font></span></blockquote></div><br class="gmail_msg"></div></div>
_______________________________________________<br class="gmail_msg">
Qgis-developer mailing list<br class="gmail_msg">
<a href="mailto:Qgis-developer@lists.osgeo.org" class="gmail_msg" target="_blank">Qgis-developer@lists.osgeo.org</a><br class="gmail_msg">
List info: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" rel="noreferrer" class="gmail_msg" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a><br class="gmail_msg">
Unsubscribe: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" rel="noreferrer" class="gmail_msg" target="_blank">https://lists.osgeo.org/mailman/listinfo/qgis-developer</a></blockquote></div><div dir="ltr">-- <br></div><div data-smartmail="gmail_signature"><div dir="ltr"><div>Alexandre Neto</div><div>---------------------</div><div>@AlexNetoGeo</div><div><a href="http://sigsemgrilhetas.wordpress.com">http://sigsemgrilhetas.wordpress.com</a></div><a href="http://gisunchained.wordpress.com">http://gisunchained.wordpress.com</a><br></div></div>
</body></html>