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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] Better issue and pull request templates #2717

Merged
merged 22 commits into from
Jul 11, 2024
Merged

[FEATURE] Better issue and pull request templates #2717

merged 22 commits into from
Jul 11, 2024

Conversation

tposejank
Copy link
Contributor

Basically, makes every issue and PR template look more fancy.

Examples

  • bug.yml
    image

  • enhancement.yml
    image

Please tell me if anything is wrong! Thanks!

NotHyper-474
NotHyper-474 approved these changes Jun 9, 2024
View reviewed changes
Copy link
Contributor

@NotHyper-474 NotHyper-474 left a comment

Choose a reason for hiding this comment

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

Tested this on my fork, it's way better and more user friendly!

charlesisfeline

This comment was marked as off-topic.

Sign in to view

@tposejank
Copy link
Contributor Author

Finally i fixed the merge issues!!

@ninjamuffin99
Copy link
Member

nice these are awesome :) I think for "question" ones like compiling help we can just neglect/remove templates, and rather use the github discussions tab.

@tposejank
Copy link
Contributor Author

nice these are awesome :) I think for "question" ones like compiling help we can just neglect/remove templates, and rather use the github discussions tab.

Done!

@EliteMasterEric EliteMasterEric added status: pending triage Awaiting review. status: needs revision Cannot be approved because it is awaiting some work by the contributor. and removed status: pending triage Awaiting review. labels Jun 17, 2024
@EliteMasterEric
Copy link
Member

EliteMasterEric commented Jun 17, 2024 •
edited
Loading

Hey @tposejank If you could modify this PR to resolve the existing merge conflicts, and use the new labels (apply the appropriate type and the status: pending triage label to all new issues) that would be great.

EDIT: A third template for crash bugs that requires uploading a log would also be great!

@tposejank
Copy link
Contributor Author

Hey @tposejank If you could modify this PR to resolve the existing merge conflicts, and use the new labels (apply the appropriate type and the status: pending triage label to all new issues) that would be great.

EDIT: A third template for crash bugs that requires uploading a log would also be great!

Alright Eric, I've noted that! I'll resolve the conflicts tomorrow because it's late. But I will add the labels.

@EliteMasterEric EliteMasterEric added the type: documentation Involves improvements or additions to documentation. label Jun 17, 2024
@tposejank
Copy link
Contributor Author

Oh well seems like I can't add labels

@tposejank
Copy link
Contributor Author

AGHHHHHHHHHH

@tposejank
Copy link
Contributor Author

FINALLY

@tposejank
Copy link
Contributor Author

Alright @EliteMasterEric, please review!

I have added the crash.yml file, a new template which is similar to the bug one but has the steps to reproduce and a crash log area which is required.

The issue and pr templates all have the status: pending triage tag to be automatically applied.

On the bug issue template, type: minor bug is applied.

On enhancement issue template, type: enhancement is applied.

On crash issue template, type: major bug is applied.

On the PR bug template, type: minor bug is applied, and on enhancement, type: enhancement.

Unfortunately, GitHub does not provide a way for users to choose which label works appropriately for the issue/pr, so the others will have to be added manually.

The merge conflicts have also been fixed. That seems to be because of mismatching diffs on the deleted bug.md file.

@tposejank
Copy link
Contributor Author

tposejank commented Jun 17, 2024 •
edited
Loading

Also yeah... PR templates kinda don't work. They're pretty useless and stale.

@EliteMasterEric
Copy link
Member

EliteMasterEric commented Jun 17, 2024 •
edited
Loading

Thank you very much! I will review this tomorrow. It should be a big help in managing future issues.

EDIT: Manually changing base branch to main because I think that's the one that issue templates pull from.

@EliteMasterEric EliteMasterEric changed the base branch from develop to main June 17, 2024 06:47
@EliteMasterEric EliteMasterEric self-assigned this Jul 11, 2024
@EliteMasterEric
Copy link
Member

I completely forgot about this PR, LOL!

If PR templates don't work, please remove them.

Otherwise, if you look into fixing the conflicts I'll merge this @tposejank

@tposejank
Copy link
Contributor Author

tposejank commented Jul 11, 2024 via email

@Hundrec
Copy link
Collaborator

Hundrec commented Jul 11, 2024

I really liked this PR and was wondering why it was stuck in limbo!

@tposejank
Copy link
Contributor Author

I completely forgot about this PR, LOL!

If PR templates don't work, please remove them.

Otherwise, if you look into fixing the conflicts I'll merge this @tposejank

done!! you can merge now @EliteMasterEric

as a remark, the bug.md inside the PR templates was renamed to PULL_REQUEST_TEMPLATE.md as that IS the correct way to do PR templates

@Hundrec Hundrec mentioned this pull request Jul 11, 2024
Closed
@EliteMasterEric
Copy link
Member

👍 I don't want to keep this in limbo because it'll save me time reviewing stuff so let's just ship it and see if it works we can make tweaks later

@EliteMasterEric EliteMasterEric merged commit 712792c into FunkinCrew:main Jul 11, 2024
@EliteMasterEric
Copy link
Member

@tposejank I don't think the PR template quite works as intended, but the issue template works fantastic and that should drastically improve things going forward!

image

@tposejank
Copy link
Contributor Author

Yeah.... I don't know why GitHub has done proper support for PR templates. It's something on their part, but important part is the "template" itself works to say the least
I sure hope it does!

@NotHyper-474
Copy link
Contributor

@EliteMasterEric EliteMasterEric added this to the 0.5.0 milestone Jul 12, 2024
@Hundrec Hundrec added status: accepted PR was approved for contribution. If it's not already merged, it may be merged on a private branch. size: large A large pull request with more than 100 changes. and removed status: needs revision Cannot be approved because it is awaiting some work by the contributor. labels Jan 22, 2025
@Hundrec Hundrec added pr: documentation PR modifies documentation or README files. pr: github PR modifies GitHub metadata files. type: github Relates to the management of issues and pull requests on GitHub. and removed type: documentation Involves improvements or additions to documentation. pr: documentation PR modifies documentation or README files. labels Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@NotHyper-474 NotHyper-474 NotHyper-474 approved these changes

@trayfellow trayfellow trayfellow approved these changes

@charlesisfeline charlesisfeline charlesisfeline approved these changes

Assignees
No one assigned
Labels
pr: github PR modifies GitHub metadata files. size: large A large pull request with more than 100 changes. status: accepted PR was approved for contribution. If it's not already merged, it may be merged on a private branch. type: github Relates to the management of issues and pull requests on GitHub.
Projects
None yet
Milestone
0.5.0
Development

Successfully merging this pull request may close these issues.
7 participants
@tposejank @ninjamuffin99 @EliteMasterEric @Hundrec @NotHyper-474 @trayfellow @charlesisfeline