Skip to content

Create issues

Jump to bottom
Todor Ivanov edited this page Dec 8, 2022 · 5 revisions

Work in the WMCore project is tracked in the format of GitHub issues, and we provide 2 templates for those:

  • Bug report: when there is a potential flaw in the software resulting in unexpected behavior or results;
  • Feature request: when either a new feature or a change of an existing feature is requested.

Once you select which template you need, a pre-filled ticket comes in and content in each section needs to be updated accordingly. For instance, the default content:

**Impact of the bug**
Inform which systems get affected by this bug. Which agent(s)? Which central service(s)?

should be updated to something like:

**Impact of the bug**
McM unable to create new workflows

Together with the GH ticket author, after understanding the actual issue requirements, the WMCore Team will properly label it, including a label for the estimate effort, as follows:

  • Low effort: ticket that will take up to 2 days of human effort;
  • Medium effort: ticket that takes more than 2 days but less than a full week of human effort;
  • High effort: ticket that takes more than a full week of human effort.

Note that tickets with "High effort" label should be broken down into smaller tickets - as sub-tasks - thus being used mostly as a super-task ticket. In addition, this effort involves any requirements/design discussions, implementation, testing and review. Deployment to production is not taken into consideration.

In addition to the effort estimation labels, there is a big set of predefined labels helping to better identify and characterize an issue. The following two in particular are having a special meaning and are supposed to be set again by WMCore Team:

  • Further Discussion: The request is in an initial stage during which further discussions with the Team requesting it or within WMCore are needed in order to better understand/set all feature requirements.
  • Revision Needed: The requested feature has been created with requirements or refer to a use case which may be no longer valid due to system evolution. The current need and the set of new requirements must be reassessed in communication with the feature requestor.
Clone this wiki locally