Skip to Content.
Sympa Menu

devel - [sympa-developpers] GitHub issue templates

Subject: Developers of Sympa

List archive

Chronological Thread  
  • From: IKEDA Soji <address@concealed>
  • To: address@concealed
  • Subject: [sympa-developpers] GitHub issue templates
  • Date: Mon, 4 Jun 2018 14:15:35 +0900

Hi folks,

I created proposals on issue template on GitHub.

About issue template (desrcription in GitHub Help):
https://help.github.com/articles/about-issue-and-pull-request-templates/

Current proposals:

* Open https://github.com/ikedas/test01/issues and click "[New issue]".

Three options for Bug report, two for Feature request and one for
genreal Question are there. We have to release each one templates
by three kinds.


Bug report
----------

There are three proposal. The last Proposal 3 reflects comments on
IRC meeting.

Table below describes differences. After it, I added some
descriptions. Reading these, please give comments
(Please refer existing issues on GitHub as actual examples).

In afew weeks, I'll release working templates considering your
comments.


| Section | Proposal 1 : Proposal 2 : Proposal 3 |
|-----------------------|------------:------------:------------|
|(Multilingual headings)| Yes : no : no |
|Expected Behavior | Yes : no : Yes |
| & Actual Behavior | : : |
|Possible Solution | Yes : no : no |
|Steps to Reproduce | Yes : no : no |
|Version | Yes : Yes : Yes |
|Configuration | Yes : Yes : no |
|Installation method | no : no : Yes |
|Additional information | Yes : no : Yes |


### Multilingual headings

This may reduce pressure to non-English users. However, it is
non-realistic (e.g. "Why is there my language?").

On the other hand, if submission form has relatively less sections
(i.e. less English words), such pressure might slightly be reduced.


### Expected Behavior & Actual Behavior

Distincting these two will make questions easier to answer for us.

However, more sections to fill up might make users hesitate to
ask questions.


### Configuration

In discussion, someones said that:

- Gathering configuration is difficult for users.
- Sensitive information (e.g. `cookie` parameter) might
be disclosed.

On the other hand, someone said configuration information
is necessary to reproduce problem in question.

I think: Need of this information depends on what kind of users we
assume.


### Installation method

This seems added with expectaion to know OS environment.


Feature request
---------------

Following to Bug report, Proposal 2 may be better.


Question
--------

Maybe nothing to talk about.


Regards,
-- Soji


--
株式会社 コンバージョン
ITソリューション部 システムソリューション1グループ 池田荘児
〒140-0014 東京都品川区大井1-49-15 アクセス大井町ビル4F
e-mail address@concealed TEL 03-6429-2880
https://www.conversion.co.jp/


  • [sympa-developpers] GitHub issue templates, IKEDA Soji, 06/04/2018

Archive powered by MHonArc 2.6.19+.

Top of Page