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

Issue template overhaul #331

Merged
merged 21 commits into from
Dec 7, 2023
Merged

Issue template overhaul #331

merged 21 commits into from
Dec 7, 2023

Conversation

moritztim
Copy link
Contributor

@moritztim moritztim commented Dec 4, 2023

Bug Report

  • Use <details>
  • Add checkboxes (except to "Other Notes")
  • Add <pre> to command output fields

(markdown formatting doesn't work one line below or above any html tag so I used <pre> to make it more compact)

  • Separate titles and instructions

Some of the titles included instructions in them, some of them in <!---> comments, now all instructions are in comments.

  • fix typo in title
  • Separate titles from each other, so the user can see the structure at a glance
  • Shorten title
  • Use headings

Feature Request

  • Make titles declarative instead of imperative
  • Change title to align with bug report
  • Use headings

@moritztim
Copy link
Contributor Author

Look at it first, maybe you don't want checkboxes cause github sees them as task lists

@moritztim
Copy link
Contributor Author

Screenshot from 2023-12-04 16-17-13
Screenshot from 2023-12-04 16-21-23

@moritztim moritztim marked this pull request as ready for review December 4, 2023 15:32
@jmmaranan
Copy link
Collaborator

Yes, it should be as simple and less friction as possible. I think checkboxes are for a PR not the issue nor feat templates. Correct that and I think everything else looks fine.

@moritztim
Copy link
Contributor Author

moritztim commented Dec 4, 2023

The advantage of not having checkboxes is you could turn the sections into headings, should I do that? With ## or ### whatever looks good.
That instead of ** ** would make it more readable and less cluttered in the editor

Co-Authored-By: Jose Maranan <[email protected]>
@moritztim moritztim marked this pull request as draft December 4, 2023 15:54
@moritztim moritztim marked this pull request as ready for review December 4, 2023 15:56
@moritztim
Copy link
Contributor Author

moritztim commented Dec 4, 2023

I used ## headings.
Try it:
https://github.com/moritz-t-w/forge/issues/new

@moritztim
Copy link
Contributor Author

Now we have cool forms :D

@moritztim
Copy link
Contributor Author

@jmmaranan please do take a look at the forms: https://github.com/moritz-t-w/forge/tree/main/.github/ISSUE_TEMPLATE to see if you agree which fields should be required

@jmmaranan jmmaranan merged commit 06777a7 into forge-ext:main Dec 7, 2023
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