Clebert, that is a fair point, mostly I was just giving examples off the top of my head. How the issue was found may or may not be relevant depending on the issue so it can be skipped. Really I just want there to be something relevant that explains the issue in some detail and how much detail depends on the complexity.
Justin, for some examples you already gave them by describing what you've been doing with putting stuff into the commit messages instead of Jira and leaving the Jira description empty. Personally, I'm not a big fan of this as I think the details should go into the Jira description so you see it immediately when you load the Jira and the commit messages should be more concise. While the commit comments get linked back to the Jira I still think the details belong in the actual description and that is more customary. But that's why I brought up a discussion thread to see what others thought. On Thu, Mar 24, 2022 at 6:11 PM Clebert Suconic <clebert.suco...@gmail.com> wrote: > Does it matter how an issue was found ? > > Some explanation in what the fix is that’s a fair point. But how it was > found seems irrelevant to me. > > > Like not trying to play sarcasm here but I once found an issue on my > dreams. (Literally) > > > > On Thu, Mar 24, 2022 at 4:26 PM Christopher’ Shannon .l.shan...@gmail.com> > wrote: > > > As I brought up in othe Artemis 2.21.0 vote thread I xolahave noticed a > > pattern > > of Jiras that have almost no information in them which makes it very > > difficult to follow along with bug fixes and new features. This made > > reviewing the current release more difficult. Some issues are trivial but > > most issues should have a good description to document the change. > > > > I am proposing that going forward we come up with a template/guide or > > checklist of some sort for Jiras for people to follow, kind of like > coding > > standards or a checklist for reviewing pull requests. > > > > It doesn't have to be super strict, but some guidelines might be nice. > Off > > the top of my head here are a few things: > > > > New Features: > > 1) What's the motivation of the feature? Why is it needed? > > 2) A high level description on the plan to implement the feature > > 2) Maybe some details on how testing will be done > > > > Bug Fixes: > > 1) How was the issue discovered? > > 2) How to reproduce and what versions are affected? > > 3) whats the proposed fix? > > > > My main motivation here is Jiras but we could also have guidelines for > > commit messages if we want too. > > > > Thoughts? > > > -- > Clebert Suconic >
