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

Remove redundancy in heading in bug report issue form #4076

Merged
merged 4 commits into from Oct 5, 2021
Merged

Remove redundancy in heading in bug report issue form #4076

merged 4 commits into from Oct 5, 2021

Conversation

opusforlife2
Copy link
Contributor

@opusforlife2 opusforlife2 commented Sep 24, 2021

Pull Request Checklist

The issue form currently generates a bug report that contains the "What happened?" heading twice. See #4047 (comment).

This PR edits the culprit heading and its subheadings to remove the redundancy and clarify what is meant.

Also made the subheadings one size smaller (4 #'s instead of 3)
@opusforlife2
Copy link
Contributor Author

@bmarty @kittykat Is it okay now?

Copy link
Member

@bmarty bmarty left a comment

Choose a reason for hiding this comment

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

OK for me

@ouchadam
Copy link
Contributor

@@ -23,12 +23,12 @@ body:
- type: textarea
id: result
attributes:
label: What happened?
label: Intended vs. Actual Result
Copy link
Contributor

Choose a reason for hiding this comment

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

Please keep capitalisation consistent with other labels

I'd prefer to use "and" instead of "vs." because it's better practice to use simpler words and no abbreviation when writing for an international audience

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done. Is it so that those who use online translators get better translations?

.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved
@kittykat
Copy link
Contributor

@bmarty should we also sync this with iOS? https://github.com/vector-im/element-ios/blob/develop/.github/ISSUE_TEMPLATE/bug.yml

Yes, please submit the same changes for element-ios and element-web (which has two forms) after this one is finalised and add me as the reviewer for those

Copy link
Member

@bmarty bmarty left a comment

Choose a reason for hiding this comment

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

@opusforlife2 will you update this PR? Else I'm afraid we will close it.

changelog.d/4076.misc Outdated Show resolved Hide resolved
@opusforlife2
Copy link
Contributor Author

Yes, please submit the same changes for element-ios and element-web (which has two forms) after this one is finalised and add me as the reviewer for those

@kittykat Is this addressed to me?

will you update this PR? Else I'm afraid we will close it.

@bmarty I'm here on weekends only. Since you guys have the weekend off, there is bound to be a mismatch between our work times, sadly.

@opusforlife2 opusforlife2 changed the title Remove redundant heading from bug report issue form Remove redundancy in heading in bug report issue form Oct 2, 2021
@bmarty
Copy link
Member

bmarty commented Oct 3, 2021

@opusforlife2 thanks for the update!

@bmarty
Copy link
Member

bmarty commented Oct 3, 2021

Yes, please submit the same changes for element-ios and element-web (which has two forms) after this one is finalised and add me as the reviewer for those

@kittykat Is this addressed to me?

I think so, yes :)

will you update this PR? Else I'm afraid we will close it.

@bmarty I'm here on weekends only. Since you guys have the weekend off, there is bound to be a mismatch between our work times, sadly.

Sure, sorry for my unnecessary pressure. We are trying to reduce the number of opened (and sometimes staled) PRs.

@bmarty
Copy link
Member

bmarty commented Oct 3, 2021

I let @kittykat approve and merge the PR

kittykat added a commit to kittykat/element-web that referenced this pull request Oct 5, 2021
Based off element-hq/element-android/pull/4076, trying out slightly
different wording

Signed-off-by: Ekaterina Gerasimova <ekaterinag@element.io>
@kittykat
Copy link
Contributor

kittykat commented Oct 5, 2021

@opusforlife2 I'm trying out slightly different wording in element-web, can you have a look at that and see what you think? Please submit a PR for element-ios and add me as a reviewer :)

kittykat added a commit to element-hq/element-web that referenced this pull request Oct 5, 2021
Based off element-hq/element-android/pull/4076, trying out slightly
different wording

Signed-off-by: Ekaterina Gerasimova <ekaterinag@element.io>
@kittykat kittykat merged commit 58b69b1 into element-hq:develop Oct 5, 2021
@github-actions
Copy link

github-actions bot commented Oct 5, 2021

Unit Test Results

  42 files  ±0    42 suites  ±0   48s ⏱️ ±0s
  83 tests ±0    83 ✔️ ±0  0 💤 ±0  0 ±0 
220 runs  ±0  220 ✔️ ±0  0 💤 ±0  0 ±0 

Results for commit 58b69b1. ± Comparison against base commit 58b69b1.

@opusforlife2 opusforlife2 deleted the issue_template branch October 11, 2021 18:51
@opusforlife2
Copy link
Contributor Author

can you have a look at that and see what you think?

@kittykat The URL you linked says "Page not found". Typo in the PR number?

Please submit a PR for element-ios and add me as a reviewer :)

Alright. Going to check out the template.

@kittykat
Copy link
Contributor

@opusforlife2 I've updated the link, do you want to check it out? Or here for the generated template

@opusforlife2
Copy link
Contributor Author

@kittykat I've submitted the Element-iOS PR, and checked out your PR in Element-Web.

Aside from that, why does the bug template here have a placeholder saying "Element version x.x.x, olm version x.x.x from F-Droid"? Shouldn't it just be the Element Android version?

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.

None yet

4 participants