Skip to content

Commit

Permalink
docs_required description update
Browse files Browse the repository at this point in the history
  • Loading branch information
wildgirl authored Dec 1, 2023
1 parent bdefd3e commit 29f9f7c
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion general/development/tracker/labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Used to flag issues that cannot be covered by automated tests. When adding the l
Used to flag issues identified in QA testing which we were not able to fix before the release. Hopefully such issues can be worked on shortly after release, removing the label once the issue is fixed.

- [`docs_required`](https://tracker.moodle.org/issues/?jql=labels%20%3D%20docs_required)<br/>
Used to flag issues that have created a need for documentation work, such as new pages, changes, or even being added to upcoming release notes. Docs people will look for these issues periodically when working on documentation, removing the label once documentation has been written. For new features in the upcoming version of Moodle, please add documentation to the dev docs (adding a link to it from the tracker issue) or in a comment in the issue, then when the new version wiki is set up (3 weeks prior to release), the info can be transferred.
Used to flag a new feature or improvement which needs documenting, or a change which requires the existing documentation to be updated. The community team go through these issues prior to a release, update the documentation and then remove the label. For major new features, a link in the tracker issue to the specification doc or draft documentation is much appreciated. :-)

- `cl_docs_required` ([all](https://tracker.moodle.org/issues/?jql=labels%20in%20(cl_docs_required)) | [yours](https://tracker.moodle.org/issues/?jql=labels%20in%20(cl_docs_required)%20AND%20assignee%20%3D%20currentUser()))<br/>
Used to flag issues that contain features which need to be documented in the [Component Library](https://docs.moodle.org/dev/Component_Library). The responsibility of creating/updating Component Library documentation falls to the developer assigned to each relevant issue. Normally the relevant documentation should be included in the issue, but in some cases this will not be the case. When the issue is resolved and component library documentation was not included, a new issue should be created for the Component Library changes, linking using the **Documents** and **is documented by** issue links, and the `cl_docs_required` label should be removed from the issue.
Expand Down

0 comments on commit 29f9f7c

Please sign in to comment.