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

Simplify Github templates #439

Merged
merged 6 commits into from
Oct 16, 2023
Merged

Simplify Github templates #439

merged 6 commits into from
Oct 16, 2023

Conversation

timbot1789
Copy link
Contributor

@timbot1789 timbot1789 commented Oct 5, 2023

This PR:

I find the formatting of our github templates hard to read, and I notice no one is really ever filling it out. I want to remove some unnecessary/redundant sections. This description is my proposed PR template.

1.
2. If needed, delete if not
3. If needed, delete if not

Screenshots (if applicable):

Add any screenshots/videos here.

Additional Context (optional):

Add any other context about the PR here.

Future Steps/PRs Needed to Finish This Work (optional):

Add any other steps/PRs that may be needed to continue this work if this PR is just a step in the right direction.

Issues needing discussion/feedback (optional):

1.
2. If needed, delete if not
3. If needed, delete if not

@xscottxbrownx
Copy link
Contributor

Personally, I don't think the thin lines break up the sections enough - but I'm not married to the current template by any means. Not a big enough issue for me to argue. I'd be perfectly okay with removing the thicker lines.

Screenshot 2023-10-05 at 4 20 49 PM

But I think ⬆️ here shows how each section is clearly divided. The automatic heading lines only underline the heading basically.


While we are at it, I vote to eliminate the The Files This PR Effects section - all of that info is found in the Files changed tab of the PR itself.

@timbot1789
Copy link
Contributor Author

Personally, I don't think the thin lines break up the sections enough - but I'm not married to the current template by any means. Not a big enough issue for me to argue. I'd be perfectly okay with removing the thicker lines.

Screenshot 2023-10-05 at 4 20 49 PM But I think ⬆️ here shows how each section is clearly divided. The automatic heading lines only underline the heading basically.

While we are at it, I vote to eliminate the The Files This PR Effects section - all of that info is found in the Files changed tab of the PR itself.

Idk maybe the issue I have is that no one is actually filling out any of these forms. At least for me, part of the reason is I see all these big thick lines and my mind goes "Ok stop here", and doesn't go further.

Maybe a happy middle is removing / combining some of these sections. I'll put up another commit with your suggestion, Scott.

### Screenshots (If applicable):
If possible, add screenshots to help explain the problem.

---
### Desktop (please complete the following information):
Copy link
Contributor Author

@timbot1789 timbot1789 Oct 6, 2023

Choose a reason for hiding this comment

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

I don't think we need these two sections. Right now, PASS is purely a browser application, so the desktop/smartphone fields aren't useful to our bug reports. The only thing that matters is the browser, and the only browser we support is the most recent version of chromium. Any bug report that isn't on the most recent version of chromium is immediately invalid.

If that changes, we can add this section back in with the configurations we support.

@timbot1789 timbot1789 changed the title Remove unnecessary horizontal lines Simplify Github templates Oct 6, 2023
@timbot1789 timbot1789 force-pushed the update-github-templates branch from 8108516 to de37fff Compare October 6, 2023 04:22
@timbot1789 timbot1789 force-pushed the update-github-templates branch from e3c42bb to abcb115 Compare October 8, 2023 19:41
@xscottxbrownx
Copy link
Contributor

@timbot1789 not sure if this is technically ready for review or not, but I'm still okay with getting rid of the lines.

I also propose dropping the concise title sections - as we already type a title for the Issue or PR (we dropped it for PR template.)

Maybe we also adjust the github auto-template stuff (whatever you want to call it) at the top of the files, or drop them too...
Like the Enhancement Request Issue has a title of Enhancement - [your title], and a label of enhancement. Maybe we can do the same for Bug Report & Feature Request.

Copy link
Contributor

@Jared-Krajewski Jared-Krajewski left a comment

Choose a reason for hiding this comment

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

Changes are fine with me. Scott and I were just talking about how these needed some attention so hopefully this help. I think we had even talked about removing the additional context section and just leaving the description as the one source to provided info. I also think we can safely remove the title headers since they are already the title of the issue once its created.

### Bug Title:
Please provide a CONCISE description of the bug.

and

### Feature Title:
Please provide a CONCISE description of the proposed feature.

@leekahung leekahung added the git-related All issues related to Github templates/issues/actions/etc. label Oct 12, 2023
@timbot1789
Copy link
Contributor Author

@xscottxbrownx @Jared-Krajewski responded to all your comments. I think this is gtg.

Copy link
Contributor

@Jared-Krajewski Jared-Krajewski left a comment

Choose a reason for hiding this comment

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

🚀

@timbot1789 timbot1789 merged commit 447283f into Development Oct 16, 2023
@timbot1789 timbot1789 deleted the update-github-templates branch October 16, 2023 00:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
git-related All issues related to Github templates/issues/actions/etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants