Skip to content

Conversation

@mkaz
Copy link
Member

@mkaz mkaz commented Dec 12, 2018

Description

A meta change that applies only to Github repo, adding a line to the PR template around developer documentation.

Developer documentation is critical for making a platform extendable, developers need to know the proper way to extend a feature, or in a sense that does may not even exist.

We discussed the importance of documentation in #docs Slack channel, and thought updating PR template is one way to call out to developers to keep it in mind.

Developer documentation is critical for making a platform extendable,
developers need to know the proper way to extend a feature, or in a
sense that does may not even exist.
@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Dec 12, 2018
Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love this idea. It's a nice subtle nudge. (Why didn't I think of this?!)

Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM; hoping to get a maintainer ✅ as well.

Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second that 👍

@chrisvanpatten chrisvanpatten merged commit ff0ca73 into master Dec 13, 2018
@chrisvanpatten chrisvanpatten deleted the update/PR-template branch December 13, 2018 18:36
youknowriad pushed a commit that referenced this pull request Jan 9, 2019
* Add a line to PR template for developer documentation

Developer documentation is critical for making a platform extendable,
developers need to know the proper way to extend a feature, or in a
sense that does may not even exist.

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-Authored-By: mkaz <[email protected]>
youknowriad pushed a commit that referenced this pull request Jan 9, 2019
* Add a line to PR template for developer documentation

Developer documentation is critical for making a platform extendable,
developers need to know the proper way to extend a feature, or in a
sense that does may not even exist.

* Update .github/PULL_REQUEST_TEMPLATE.md

Co-Authored-By: mkaz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants