Skip to content

Tickets

Thomas Perret edited this page Oct 22, 2014 · 3 revisions

Working with tickets

GitHub uses the term Issue, we are refering to tickets.

When reporting a ticket:

  • Try to describe the problem (what were you doing, python's stack trace, what's missing,...)
  • Tag your bug accordingly (create labels ONLY if you REALLY need it)

Labels meanings

  • bug : regression, faulty feature, crash, bad results,...
  • cleanup : lisibility improvment, factorization, refactoring,...
  • data : everything concerning included data
  • documentation : fix of mainstream documentation, downstream documentation
  • investigate : unrepoductible bug, alternate implementation,...
  • new feature : new development (core, algorithm, interface,...)
  • optimization : fix slow code, memory optimization, decrease disk usage,...
  • packaging : development tools (distribution integration, continuous integration, code coverage,...)

other labels

  • wish : request for new feature or improvment
  • duplicate : refers to an already existing ticket
  • invalid : invalid request (bug is a feature, new feature contradict specifications,...)
  • question : general question (how to, usage clarifications...) or bug open to discussion
  • wontfix : ticket not doable (slow code can't be improved, bug is not fixable,...)

Managing tickets

Working on a ticket

  • Mark yourself assigned to this ticket
  • If possible add milestone

Closing a ticket

  • When you consider the job done you can mark it closed. If you close it using a commit it will be automatically linked, otherwise please link a commit in closing comment on GitHub.

Clone this wiki locally