[Qgis-developer] 3.0 Documentation and branching

[Nyall Dawson]

On 7 March 2017 at 00:26, DelazJ <delazj at gmail.com> wrote:
>
> 2017-03-06 15:20 GMT+01:00 Matthias Kuhn <matthias at opengis.ch>:
>>
>>
>> Sorry, I explained badly. Pull requests are perfectly fine and desirable
>> and should be the standard way to contribute for everyone (including
>> devs). What I wanted to say is that commits (and therefore pull
>> requests) are preferable over issues because they are written in rst and
>> not md, unlike issues.
>>
> I can't disagree this time!

Been thinking about this issue.... Here's what I'm thinking now:

For a while I've pondered whether we should require that all
developers who push a feature also push documentation for that
feature. But after careful thought, I don't think this is a good move.
Here's some reasons why:

- good developers arent necessarily good writers, nor have good English skells
- there's a time investment in learning the documentation setup. This
may detract developers.

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!

Nyall