MerchDocs Issues Backlog - ccondra/merchdocs GitHub Wiki

The MerchDocs Backlog is a project for grooming and tracking issues. Project automation adds progress labels.

The dashboard provides issue support for:

  • Contributors who are looking for issues that are ready and available for development/PR
  • Magento Documentation team members to groom new issues

Dashboard columns and issue logic

The MerchDocs Backlog project has several columns. Each column has specific automation logic based on issue conditions, such as labels, assignee, etc. As issues are entered and worked, a non-human user (or bot) moves issue cards on the board through the columns. Each column has specific logic to determine where issues go.

Review the following to best understand how to work on issues.

Ready for Grooming

All new, submitted issues are automatically added to this column. Magento Documentation team members review and update these tickets to make them ready for development.

Ready for Development

Magento Documentation team members move tickets from Ready for Grooming to this column. All issues receive the label Progress: ready for development.

All issues in this column are available and free to claim and work. Review the issues and feel free to assignee it to you, and start working on it. When claimed, the issue moves to the Dev in Progress column.

Good First Issue

This column contains issues that are great for beginners new to Magento docs or contributing. All issues are open, unclaimed, and have good first issue label. If you have any questions, join us in #beginners and #merchdocs Slack channels (or self join).

Review the issues and feel free to assignee it to you, and start working on it. When claimed, the issue moves to the Dev in Progress column.

Dev in Progress

When an issue is claimed or assigned, the issue moves to this column. This means the issue is being worked actively. These issues have a Progress: dev in progress label.

Pull Request in Progress

This column contains Issues that have related Pull Requests in an Open state. If you include Issue link(s) in the Pull Request description, the issue automatically assignees the PR author to this issue and moves it to this column. These issues have a Progress: PR created label.

Done

This column tracks all closed issues. All labels added through automation are removed.

Additional information

Issues may include a number of labels to track their review and progress, as well as release lines, and more.

For more information on labels used, you may want to review: