search

fecgov / openFEC

The first RESTful API for the Federal Election Commission. We're aiming to make campaign finance more accessible for journalists, academics, developers, and other transparency seekers.
https://api.open.fec.gov/developers
Other
482 stars 106 forks source link

Consider creating template for back-end and database tickets #4703

Open dorothyyeager opened 3 years ago

dorothyyeager commented 3 years ago

We should consider creating a template (and determining if this is desired) to make it easier to submit back-end and database tickets/reports/issues and better ensure tickets have crucial and helpful other information to speed vetting, grooming, and addressing issues.

Similar template ticket was done for CMS and has been very helpful for writing those tickets: https://github.com/fecgov/fec-cms/issues/2820. Any template created doesn't need to have those elements; it should be customized as back-end and database team members would find helpful.

PaulClark2 commented 3 years ago

If we decide on a template, maybe it could be simple with three sections:

  1. Why we need this (Why we are doing this)
  2. Technical considerations (This should not technical steps to do the work. It should be consider this? Check this thing? Make sure the change doesn't break this other thing.)
  3. Completion criteria

Of course the person entering the ticket can include more information if they have it or if it helps explain the issue.