Skip to content

Further improve issue template #6816

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

Merged
merged 11 commits into from
Jul 29, 2020
Merged

Further improve issue template #6816

merged 11 commits into from
Jul 29, 2020

Conversation

TomWFox
Copy link
Contributor

@TomWFox TomWFox commented Jul 20, 2020

Following further discussion on #6805

@TomWFox TomWFox requested a review from mtrezza July 20, 2020 18:13
@mtrezza
Copy link
Member

mtrezza commented Jul 20, 2020

What do you think about this:

  • For the checklist, I would consolidate the info and link to the support page. We can add all details there about StackOverflow, its tags and the Parse Community Forum. We can be more verbose there and avoid mentioning all this in every issue. If that's not effective enough and we still get non-issues here, I'd suggest let's take another look.
  • The support section on the main page still suggest that using the latest version of Parse Server is a requirement to open an issue. The support section should be removed so we don't have to maintain duplicate information. Anyhow, why don't we make upgrading to the latest version a requirement in the issue template, instead of v2.3.2? I understand that a production system may not be able to upgrade immediately to the latest version, so I changed the checklist point to "being able to reproduce the issue in the latest version". I have come across a couple of issues lately that concerned old versions of Parse Server and the answer was like "we can't tell for sure, try upgrading, you're running a version that's 2 years old". We want to encourage people to upgrade anyway to get more feedback on new releases. And I also think that migration support to 3.x (how to write async/await promises) is getting old at this point. That seems to be a better fit for a commercial offer of Parse Server support.
  • Changed the order of the checklist according to importance (never post security issues) and frequency (don't post questions).
  • Removed the "Hardware" question from the environment topic as it doesn't seem to be necessary in most cases; in specific cases that would be inquired in the process I assume.
  • Removed "MongoDB Storage Engine" from environment topic, because since MongoDB 3.2, the WiredTiger storage engine is the default storage engine.
  • Changed the [FILL THIS OUT] to FILL_THIS_OUT to make it easier selectable by double click.
  • Updated the remote host list (added MongoDB Atlas as mLab successor)
  • Added foldable logs section for better overview when posting long logs; (that may encourage posting of excessive logs)
  • Changed the order of actual outcome and expected outcome; maybe it's just me, but in the process of describing the issue and the steps I get to the actual result first, after that I would explain what I expected to get, that's at least my order of thinking.
  • Added comment descriptions below each heading for guidance.
  • Added "Client" to environment, because we cannot expect the author to identify at this point whether the issue is related to Parse Server or a Parse SDK, so that info can expedite issue analysis.

New Issue Checklist

<!-- Please check the following boxes [ ] -> [x] before submitting your issue. Click the "Preview" tab for better readability. -->

Issue Description

<!-- What is the specific issue with Parse Server? -->

Steps to reproduce

<!-- How can someone else reproduce the issue? -->

Actual Outcome

<!-- What outcome, for example query result, did you get? -->

Expected Outcome

<!-- What outcome, for example query result, did you expect? -->

Environment

<!-- Be specific with versions, don't use "latest" or semver ranges like "~x.y.z" or "^x.y.z". -->

Server

  • Parse Server version: FILL_THIS_OUT
  • Operating system: FILL_THIS_OUT
  • Local or remote host (AWS, Azure, Google Cloud, Heroku, Digital Ocean, etc): FILL_THIS_OUT

Database

  • System (MongoDB or Postgres): FILL_THIS_OUT
  • Database version: FILL_THIS_OUT
  • Local or remote host (MongoDB Atlas, mLab, AWS, Azure, Google Cloud, etc): FILL_THIS_OUT

Client

  • SDK (iOS, Android, JavaScript, PHP, Unity, etc): FILL_THIS_OUT
  • SDK version: FILL_THIS_OUT

Logs

<!-- Include relevant logs here. Turn on additional logging by configuring VERBOSE=1 in your environment. -->

@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 21, 2020

@mtrezza I agree with all your points and I'd be happy to go with your suggested changes (with a couple word changes). I was hesitant to just ask people to read certain docs, like fastlane do in the example you shared, as I suspect most wouldn't but the way you have worded it gives the basic point ('I am not just asking a question') whilst giving the author to see more detail if they are unsure - I like it!

@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 21, 2020

I didn't realise that was even in the readme, but don't check the blame cause chances are I added or edited it!!

@TomWFox TomWFox marked this pull request as draft July 21, 2020 07:49
@codecov

This comment has been minimized.

Copy link
Member

@mtrezza mtrezza left a comment

Choose a reason for hiding this comment

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

lgtm

@mtrezza
Copy link
Member

mtrezza commented Jul 21, 2020

Do you want to clean up the Github issue list in the same go?

I see several issues with the current list, for example

  • we show the "Getting help" (Community Forum) before "Report an issue"
  • remove the separate issue template for push notifications
  • remove the parse server 3.0 migration issue template
  • show the report vulnerability as 1st entry(?)
  • change the subtexts to make it clearer which option is for what purpose
  • clearly differentiate between reporting an issue / asking for help (SO) / discuss anything else (community forum)

image

Here is a suggestion:

  • Title: 🐛 Report an issue
  • Subtext: A feature of Parse Server is not working as expected.
  • Button title: Get started

  • Title: ⭐️ Request a feature
  • Subtext: Suggest new functionality or enhancement of existing functionality.
  • Button title: Get started

  • Title: ❓ Get support
  • Subtext: Get help with setting up and running Parse Server on StackOverflow.
  • Button title: Open (link)

  • Title: 🙋 Open a discussion
  • Subtext: Discuss a topic related to Parse Server in our Community Forum.
  • Button title: Open (link)

  • Title: ⚠️ Report a vulnerability
  • Subtext: Confidentially report a security issue with Parse Server.
  • Button title: Get started

@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 21, 2020

  • The list is ordered alphabetically by the file name, but I could probably change the names to reorder them.
  • It's not possible to put the vulnerability option first (part of GitHub UI not an issue template)
  • Can't change the button title

@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 21, 2020

Actually it seems there are some more config options than I realised (or they're new!) - doc. I'll see what I can do with this.

@mtrezza
Copy link
Member

mtrezza commented Jul 22, 2020

Actually it seems there are some more config options than I realised (or they're new!) - doc. I'll see what I can do with this.

Yep, that's what I was referring to. It may be something like this:

blank_issues_enabled: false
contact_links:
  - name: ❓ Get support
    url: <url to SO>
    about: Get help with setting up and running Parse Server on StackOverflow.

I think these are just appended to the bottom of the list then but they show a different button:
image

That would move "Report a vulnerability" above them and we end up again with having the "Get support" down in the list, risking that authors tend to "Report an issue" rather than posting on SO. I just suggested the "Open" button because it makes it more clear that the user is leaving Github, but that's less important than preventing non-issues on Github. I leave it up to you what you think makes more sense to do.

Other than that for me it's ready to merge, although I can see only see 2 files renamed to get the order right, I assume the other file names already produce the correct order?

@mtrezza mtrezza marked this pull request as ready for review July 22, 2020 00:29
@TomWFox TomWFox marked this pull request as draft July 25, 2020 16:47
@TomWFox TomWFox marked this pull request as ready for review July 25, 2020 17:03
@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 25, 2020

Right, I've delete the other issue templates and added the config so that there is now a link to stack overflow and the forum. I need to make a PR to the .github repo to update the support doc but I think that can wait a couple days :)

@TomWFox TomWFox requested review from davimacedo and dplewis July 25, 2020 17:05
@TomWFox TomWFox merged commit 19264ba into master Jul 29, 2020
@TomWFox TomWFox deleted the TomWFox-patch-1 branch July 29, 2020 20:26
@mtrezza
Copy link
Member

mtrezza commented Jul 29, 2020

I like it 👏 Can't wait for the first issue to be posted 😁

@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 29, 2020

@mtrezza Yeah it's much better! Thanks for assisting 🤝

@mtrezza
Copy link
Member

mtrezza commented Jul 29, 2020

I noticed that some icons and subtexts are different that the suggestion. No big deal, if that's on purpose I'm fine with it, but just to let you know in case it was unintentional. 🙂 I didn't notice that during the review somehow.

@TomWFox
Copy link
Contributor Author

TomWFox commented Jul 29, 2020

@mtrezza It was intentional, I probably could have mentioned it though!

@mtrezza
Copy link
Member

mtrezza commented Jul 29, 2020

That's fine, these type of meta changes can also be somewhat difficult to review.

therealjmj pushed a commit to therealjmj/SC-parse-server that referenced this pull request Aug 20, 2020
* Update ---report-an-issue.md

* mtrezza's suggestions

* remove support from readme

* Rename ---report-an-issue.md to ---1-report-an-issue.md

* Update ---feature-request.md

* Rename ---feature-request.md to ---2-feature-request.md

* Delete ---getting-help.md

* Delete ---push-notifications.md

* Delete ---parse-server-3-0-0.md

* Create config.yml

* change support link to org wide doc
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.

2 participants