Documentation change "mechanics" at Github

Lubomir I. Ivanov neolit123 at gmail.com
Thu Nov 16 06:53:32 PST 2017


On 16 November 2017 at 16:41, Lubomir I. Ivanov <neolit123 at gmail.com> wrote:
> hi, Willem and all.
>
> today we've added a 'needs-documentation-change' label at Github.
> also, Pull Request will now have a "Documentation change" section
> after this update is approved:
> https://github.com/Subsurface-divelog/subsurface/pull/823
>
> so basically, for those editing the docs you can browse Github pull
> requests with this filter:
> https://github.com/Subsurface-divelog/subsurface/pulls?q=is%3Apr+is%3Aclosed+label%3Aneeds-documentation-change
>
> or access it with from here:
> https://github.com/Subsurface-divelog/subsurface/ -> Pull Requests ->
> Labels -> find "needs-documentation-change".
>
> and see if a PR has made changes that affect the Subsurface
> documentation either by looking at the "Documentation change" section
> in the PR body or looking at the code/diff itself.
>
> see here:
> https://github.com/Subsurface-divelog/subsurface/pull/809
>
> "added new combo-box in BT dialog."
>
> something else we are doing is to encourage the PR submitters to edit
> the ReleaseNotes/ReleseNotes.txt file, with the changes they've made.
>

forgot to outline that you should be looking out for *Closed* (via
github UI button) and merged PRs that have the new label.

lubomir
--


More information about the subsurface mailing list