Totally agree with Harrissou. A good description in the commit with the rigth tags should be enough.
Alex Neto A ter, 7/03/2017, 10:06, DelazJ <[email protected]> escreveu: > Hi, > > 2017-03-07 5:58 GMT+01:00 Nyall Dawson <[email protected]>: > > > > I think a better solution is to hook into the current > [FEATURE]/[NEEDS-DOCS] hooks which auto-open issues on the > documentation repo. We could *require* that all developers who push a > new feature commit have to post on the corresponding documentation > auto-opened issue with at least very rough notes about how the feature > is supposed to work. The documentation team could then polish these > up, add screenshots, etc (and merge when the timing is right for the > team). This would also keep things as easy as possible for devs so > that they (*cough*... i mean me *cough*) have no excuse not to do it! > > You are right, Nyall. > 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?). > > Also note that a verbose commit benefits to the Changelog team, when time > comes.... > > Harrissou > > Nyall > > > _______________________________________________ > Qgis-developer mailing list > [email protected] > List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer > Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer -- Alexandre Neto --------------------- @AlexNetoGeo http://sigsemgrilhetas.wordpress.com http://gisunchained.wordpress.com
_______________________________________________ Qgis-developer mailing list [email protected] List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
