How we use issues

We use labels and release milestones on the GitHub issues tracker at github.com/dita-ot/docs/issues to manage DITA-OT documentation tasks.

This allows us to organize issues by category, prioritize tasks and filter the list of items to show a certain subset.

Milestones

We assign milestones to issues to indicate the release version in which the issue was (or will be) resolved. Open issues with assigned milestones indicate tasks which are scheduled for implementation in an upcoming release. If no milestone is associated with an issue, the task has not yet been scheduled.

Assigned Issues

Issues are assigned to a team member to indicate work in progress. When you begin working on an issue, assign it to yourself so others know you're on the job. If an issue is already assigned to someone else, check with them before making related changes to avoid conflicts.

Issue Label Legend

Many of these labels are GitHub defaults, but some are specific to the DITA-OT docs repository.

coverage

The coverage label flags issues related to incomplete information in existing topics, such as missing descriptions of parameters, extension points, properties, etc.

help wanted

Issues are marked help wanted to indicate areas where contributions would be particularly welcome, or topics that may require additional input from other team members.

outdated content

This label flags topics that may require updates to reflect changes in recent toolkit versions.

refactoring

These issues typically propose changes to the file structure, DITA markup or other aspects of the underlying project organization that may not be immediately visible to the reader but that would improve code quality, consistency, or align with recent best practices.

terminology

Terminology issues flag topics where terms may need to be aligned for consistency.