Skip to content

feat(issue-template): Add Object documentation issue template

Nadia Sotnikova requested to merge nadia_sotnikova-main-patch-79352 into main

This MR adds a new Object documentation issue template to be used for making additions and updates to Objects.

Based on my experience with documenting the job object (currently going through a final review) I've put together an MVC issue template for documenting an object. It outlines the basic steps and recommendations and links some helpful resources to get started.

It would be great to get more object contributions from other PDs so we can refine the process, and having some basic contribution guidelines in place would help with that.

We have a separate page for component contributions in the Component lifecycle page.. It doesn't seem justified at this stage of object process maturity to create a separate page for Object contributions. As an MVC I'd suggest to link to the Object documentation issue template in the Object overview page to enable further contributions and iteration on the process.

To-do's

  • Create a WIP draft with basic steps
  • Add the recommendations for working on an object model diagram
  • Link helpful resources such as the Object overview page, the article on object modeling we refer to, and links to examples.
  • Gather feedback

Relates to #1151 (closed)

Edited by Nadia Sotnikova

Merge request reports