[Freeipa-devel] Pagure issue template

Post by Petr Vobornik
Hi all,
I'd like to improve quality of bug reports and RFEs.
A possibility I see is to create and issue template [1].
What do you think of the following template? Should we use it?
""""
### Request for enhancement
As <persona> , I want <what?> so that <why?>.
### Bug
#### What doesn't work (what was the goal)
#### Steps to Reproduce
#### Actual results
#### Expected results
#### Version/Release/Distribution
$ rpm -q freeipa-server ipa-server 389-ds-base pki-ca krb5-server
""""

1. Can we add pre-defined set of components in title ? for example,

[CERT] some_cert_related bug description
[installer] some installer related bug description

2. Also, Having a bot in place which will enforce or atleast suggest
reporter to modify bug report.

Post by Petr Vobornik
[1] https://docs.pagure.org/pagure/usage/ticket_templates.html

--
Abhijeet Kasurde
Red Hat Identity management, RHCSA,
Red Hat APAC
***@redhat.com
www.redhat.com | TRIED. TESTED. TRUSTED. | redhat.com/trusted

--
Manage your subscription for the Freeipa-devel mailing list:
https://www.redhat.com/mailman/listinfo/freeipa-devel
Contribute to FreeIPA: http://www.freeipa.org/page/Contribute/Code

Standa Laznicka

2017-04-21 06:49:04 UTC

Post by Abhijeet Kasurde
+1

Post by Petr Vobornik
Hi all,
I'd like to improve quality of bug reports and RFEs.
A possibility I see is to create and issue template [1].

Sounds like a good idea! Please see my comments.

Post by Petr Vobornik
What do you think of the following template? Should we use it?
""""
### Request for enhancement
As <persona> , I want <what?> so that <why?>.

This sounds very labored. How about using:
"I am a <org_role> and I want ..."

Post by Petr Vobornik
### Bug
#### What doesn't work (what was the goal)

<nitpick>"What's not working" proposes the situation will change and
sounds better IMO</nitpick>

Post by Petr Vobornik
#### Steps to Reproduce
#### Actual results
#### Expected results
#### Version/Release/Distribution
$ rpm -q freeipa-server ipa-server 389-ds-base pki-ca krb5-server
""""

1. Can we add pre-defined set of components in title ? for example,
[CERT] some_cert_related bug description
[installer] some installer related bug description

This is what Pagure has tags for. But you're right we might be missing
some, although "CERT" is probably not a good example, installer is. On
the other hand, "userstory" is a tag I will myself never use on purpose.

Post by Abhijeet Kasurde
2. Also, Having a bot in place which will enforce or atleast suggest
reporter to modify bug report.

Post by Petr Vobornik
[1] https://docs.pagure.org/pagure/usage/ticket_templates.html

My hope is that the issue template should do itself.

For the record, I love the way Atom guides you through their issue
creation: https://github.com/atom/atom/issues/new.

--
Manage your subscription for the Freeipa-devel mailing list:
https://www.redhat.com/mailman/listinfo/freeipa-devel
Contribute to FreeIPA: http://www.freeipa.org/page/Contribute/Code

Petr Vobornik

2017-04-21 08:17:54 UTC

Post by Abhijeet Kasurde
+1

Post by Petr Vobornik
Hi all,
I'd like to improve quality of bug reports and RFEs.
A possibility I see is to create and issue template [1].

Sounds like a good idea! Please see my comments.

Post by Petr Vobornik
What do you think of the following template? Should we use it?
""""
### Request for enhancement
As <persona> , I want <what?> so that <why?>.

"I am a <org_role> and I want ..."

Post by Petr Vobornik
### Bug
#### What doesn't work (what was the goal)

<nitpick>"What's not working" proposes the situation will change and
sounds better IMO</nitpick>

I took some inspiration from the Atom template. But tried to keep it
shorter. As a bonus I added a link where people can find log files and a
link to troubleshooting page.

New one:
"""
### Request for enhancement
As <persona, e.g. admin> , I want <what?> so that <why?>.

### Issue
[description of the issue]

#### Steps to Reproduce
1.
2.
3.

#### Actual behavior
(what happens)

#### Expected behavior
(what do you expect to happen)

#### Version/Release/Distribution
$ rpm -q freeipa-server freeipa-client ipa-server ipa-client
389-ds-base pki-ca krb5-server

#### Additional info:
Any additional information, configuration, data or log snippets that is
needed for reproduction or investigation of the issue.

Log file locations:
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Linux_Domain_Identity_Authentication_and_Policy_Guide/config-files-logs.html
Troubleshooting guide: https://www.freeipa.org/page/Troubleshooting
"""

Post by Abhijeet Kasurde
1. Can we add pre-defined set of components in title ? for example,

I don't know if it is possible. Probably not.

Post by Abhijeet Kasurde
[CERT] some_cert_related bug description
[installer] some installer related bug description

Post by Abhijeet Kasurde
2. Also, Having a bot in place which will enforce or atleast suggest
reporter to modify bug report.

Could you elaborate?

Post by Petr Vobornik
[1] https://docs.pagure.org/pagure/usage/ticket_templates.html

My hope is that the issue template should do itself.
For the record, I love the way Atom guides you through their issue
creation: https://github.com/atom/atom/issues/new.

--
Petr Vobornik

Associate Manager, Engineering, Identity Management
Red Hat

--
Manage your subscription for the Freeipa-devel mailing list:
https://www.redhat.com/mailman/listinfo/freeipa-devel
Contribute to FreeIPA: http://www.freeipa.org/page/Contribute/Code

Simo Sorce

2017-04-26 18:41:51 UTC

Post by Petr Vobornik

Post by Abhijeet Kasurde
+1

Post by Petr Vobornik
Hi all,
I'd like to improve quality of bug reports and RFEs.
A possibility I see is to create and issue template [1].

Sounds like a good idea! Please see my comments.

Post by Petr Vobornik
What do you think of the following template? Should we use it?
""""
### Request for enhancement
As <persona> , I want <what?> so that <why?>.

"I am a <org_role> and I want ..."

Post by Petr Vobornik
### Bug
#### What doesn't work (what was the goal)

<nitpick>"What's not working" proposes the situation will change and
sounds better IMO</nitpick>

I took some inspiration from the Atom template. But tried to keep it
shorter. As a bonus I added a link where people can find log files and a
link to troubleshooting page.
"""
### Request for enhancement
As <persona, e.g. admin> , I want <what?> so that <why?>.
### Issue
[description of the issue]
#### Steps to Reproduce
1.
2.
3.
#### Actual behavior
(what happens)
#### Expected behavior
(what do you expect to happen)
#### Version/Release/Distribution
$ rpm -q freeipa-server freeipa-client ipa-server ipa-client
389-ds-base pki-ca krb5-server
Any additional information, configuration, data or log snippets that is
needed for reproduction or investigation of the issue.
https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/7/html/Linux_Domain_Identity_Authentication_and_Policy_Guide/config-files-logs.html
Troubleshooting guide: https://www.freeipa.org/page/Troubleshooting
"""

Post by Petr Vobornik

Post by Abhijeet Kasurde
1. Can we add pre-defined set of components in title ? for example,

I don't know if it is possible. Probably not.

Post by Abhijeet Kasurde
[CERT] some_cert_related bug description
[installer] some installer related bug description

Post by Abhijeet Kasurde
2. Also, Having a bot in place which will enforce or atleast suggest
reporter to modify bug report.

Could you elaborate?