Skip to content

Include raw docs in Feature PRs #1510

@aluzzardi

Description

@aluzzardi

I propose we start requiring medium-to-large feature PRs to come with raw documentation (e.g. mostly bullet points on what it is, how to use it, example).

It's not intended to be user facing documentation, the goal is to:

  • Provide raw material we'll be using to write documentation later on (instead of having to ping the author and ask to explain)
  • Make sure we don't forget to document some slightly obscure features (e.g. Support for partially running a DAG #1302)
  • Provide a starting point for Europa testers while we work on "proper" docs
  • See the feature in action. Helps PR review.

For instance, in the current PR pipeline, that would include:

I'd like to hear your thoughts @gerhard -- if you think this is a good idea, do you have an opinion on the implementation?

/cc @talentedmrjones @jlongtine @shykes

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions