Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[documentation] #2446: improve issue templates #2448

Merged
merged 1 commit into from
Jul 8, 2022
Merged

[documentation] #2446: improve issue templates #2448

merged 1 commit into from
Jul 8, 2022

Conversation

6r1d
Copy link
Contributor

@6r1d 6r1d commented Jul 7, 2022

Description of the Change

This PR adds detailed forms to fill into the issues. To see the issue form, open this page.

Issue

This PR closes #2446 and covers all the items in it.

Benefits

  • Contributors sending the bug requests will fill the form with all the details that are needed for quicker debugging.
  • The supported branches of Iroha are immediately visible.
  • Contributors also see who to tag, so the issue gets resolved faster.
  • People who have questions will immediately see Discord and Telegram community links.

Possible Drawbacks

I have several questions I'll be marking as resolved here.
UPD: these questions were resolved.

  • I am not sure where to redirect people who have an SDK problem. In addition to that, it is possible to add a link to SDK in /issues/new/choose. This detail needs to be considered before the merge.
  • The Discord server link with #iroha channel shows a Telegram bridge and little activity. Is it the current actual Discord for Iroha?
  • The tags are auto-filled and need a change; I have not seen a stable tag, so both types of issues are tagged the same way, making it confusing.
  • This PR still has blank_issues_enabled as true for now. I think this will need a bit of a discussion: should we have blank issues in addition to the "bug" issues for questions, not related to bugs or future planning?
  • I am not sure if this is the correct documentation link for JSON logs. While all the details match, is it the correct doc to refer to?

Alternate Designs

At a later date, there may be an internal command to collect most of the current Iroha environment data: LibC version, OS info, etc. I am not sure if this can be done reliably all the time, so I am thinking of implementing this at a later date.

@6r1d 6r1d changed the title [documentation]: improve issue templates [documentation] #2446: improve issue templates Jul 7, 2022
@outoftardis
Copy link
Contributor

what about mentioning we have a contributing guide? https://github.com/hyperledger/iroha/blob/iroha2-dev/CONTRIBUTING.md

@outoftardis
Copy link
Contributor

I am not sure if this is the correct documentation link for JSON logs. While all the details match, is it the correct doc to refer to?

I think you want this one: https://github.com/hyperledger/iroha/blob/iroha2-dev/docs/source/references/config.md#logger

@outoftardis
Copy link
Contributor

outoftardis commented Jul 7, 2022

The Discord server link with #iroha channel shows a Telegram bridge and little activity. Is it the current actual Discord for Iroha?

Iroha channel: https://discord.com/channels/905194001349627914/905205848547155968
But I believe telegram channel is much more active, so I don't know if we even need to provide a link to Discord

.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/stable-bug.yml Outdated Show resolved Hide resolved
@6r1d
Copy link
Contributor Author

6r1d commented Jul 7, 2022

what about mentioning we have a contributing guide? https://github.com/hyperledger/iroha/blob/iroha2-dev/CONTRIBUTING.md

I like that idea, plus it has yet another category we can add besides the bugs:

Note: Issues such as outdated documentation, insufficient documentation, or feature requests should use the Documentation or Enhancement labels. They are not bugs.

In regards to "attaching a screenshot", it's better to update that small part of the doc right after, because we're requesting JSON logs.

Copy link
Contributor

@outoftardis outoftardis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same comments for the stable bug template

.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
@outoftardis
Copy link
Contributor

a note: please check contributing guidelines, one PR = one commit (we don't squash commits when the pr is merged)

@outoftardis
Copy link
Contributor

please also update the commit message: docs: improve issue templates -> [documentation] #2446: Improve issue templates
and sign-off the commit

.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/stable-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/documentation.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/stable-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/stable-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/lts-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/stable-bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/feature-request.yml Outdated Show resolved Hide resolved
Cre-eD
Cre-eD previously approved these changes Jul 8, 2022
Signed-off-by: Victor <vic.6r1d@gmail.com>
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
@6r1d 6r1d merged commit 1ad7362 into hyperledger:main Jul 8, 2022
6r1d added a commit to 6r1d/iroha that referenced this pull request Jul 8, 2022
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha that referenced this pull request Jul 8, 2022
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha that referenced this pull request Jul 8, 2022
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha that referenced this pull request Jul 8, 2022
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha that referenced this pull request Jul 8, 2022
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha that referenced this pull request Jul 8, 2022
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha that referenced this pull request Jul 8, 2022
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
6r1d added a commit to 6r1d/iroha that referenced this pull request Jul 8, 2022
Signed-off-by: 6r1d <vic.6r1d@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create issue templates
4 participants