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

[READ THIS BEFORE OPENING ISSUES] Your Guide to Funkin' GitHub Issues! #4050

Open
Hundrec opened this issue Jan 26, 2025 · 11 comments
Open

[READ THIS BEFORE OPENING ISSUES] Your Guide to Funkin' GitHub Issues! #4050

Hundrec opened this issue Jan 26, 2025 · 11 comments
Labels
type: github Relates to the management of issues and pull requests on GitHub.

Comments

@Hundrec
Copy link
Collaborator

Hundrec commented Jan 26, 2025

Your Guide to Funkin' GitHub Issues!

So you want to contribute to Friday Night Funkin'?

Read this guide to learn how to submit the most helpful issues you can!

Requirements

Make sure you're playing:

  • the latest version of the game (currently v0.5.3)
  • without any mods
  • on Newgrounds or downloaded from itch.io

Rejected Features

If you want to suggest a feature, make sure it hasn't already been rejected by the devs!
Here's a list of commonly suggested features that probably won't be added:

Feature Reason
Combo Break + Accuracy Displays #2681 (comment)
Toggleable Ghost Tapping #2564 (comment)
Perfectly Centered Strumlines same as above^
Losing Icons for DD and Parents #3048 (comment)
Playable GF / Speaker BF / Speaker Pico #2953 (comment)
Adjusted Difficulty Ratings #2781 (comment)
Countdown after Unpausing #2721 (comment)
Importing Charts from Psych Engine (and other mod content) #2586 (comment)
Backwards Compatibility for Modding #3949 (comment)
Lua Support #2643 (comment)

Issue Types

Choose the issue template that best suits your needs!
Here's what each template is designed for:

Bug Report (view list)

For minor bugs and general issues with the game. Choose this one if none of the others fit your needs.

Crash Report (view list)

For crashes and freezes like the Null Object Reference problem from v0.3.0.

Charting Issue (view list)

For misplaced notes, wonky camera movements, broken song events, and everything related to the game's charts.

Enhancement (view list)

For suggestions to add new features or improve existing ones. We'd love to hear your ideas!

Compiling Help (only after reading the Troubleshooting Guide)

For issues with compiling the game. Legacy versions (before v0.3.0) are not supported.

Before You Submit...

Use the search bar on the Issues page to check that your issue hasn't already been reported by someone else!
Duplicate issues make it harder for the devs to keep track of important issues with the game.

Also only report one issue or enhancement at a time! That way they're easier to track.

Once you're sure your issue is unique and specific, feel free to submit it.

Thanks for contributing to the Funkin' GitHub!

@Hundrec Hundrec added status: pending triage Awaiting review. type: enhancement Involves an enhancement or new feature. and removed type: enhancement Involves an enhancement or new feature. status: pending triage Awaiting review. labels Jan 26, 2025
@KoloInDaCrib
Copy link
Contributor

Thank you hundrec that's awesome! You should probs get eric to pin this at some point soon

@AbnormalPoof AbnormalPoof added the type: github Relates to the management of issues and pull requests on GitHub. label Jan 26, 2025
@EliteMasterEric EliteMasterEric pinned this issue Jan 26, 2025
@Lasercar
Copy link
Contributor

Can there be a list of all the known bugs? It'd help cut down on the number of duplicate reports.

@Hundrec
Copy link
Collaborator Author

Hundrec commented Jan 27, 2025

For now, the best way to determine whether your issue has been reported is by searching for it on the Issues page. You can filter by tags and view already resolved issues if you want to.

@Lasercar
Copy link
Contributor

Add this info to this issue:

In an enhancement issue that contained a lot of minor enhancements, Eric said this: Image

Also, say, only a few enhancements from a mega enhancement issue get completed - should the entire issue get closed then? If not then there would need to be a checklist in the mega enhancement issue so that the members could check off what was completed. However what if some of the enhancement ideas get rejected? To put it simply - it would be a nightmare to deal with

@Hundrec
Copy link
Collaborator Author

Hundrec commented Jan 31, 2025

Already included!

@Lasercar
Copy link
Contributor

Lasercar commented Feb 1, 2025

Thank you hundrec that's awesome! You should probs get eric to pin this at some point soon

@EliteMasterEric
I'm not sure if you've seen this yet, so I'm pinging you so that you do?

@Hundrec
Copy link
Collaborator Author

Hundrec commented Feb 1, 2025

Oh, he already pinned this

Image

@Lasercar
Copy link
Contributor

Lasercar commented Feb 1, 2025

oh, huh, then why is it falling down the issues list?

Wait, I'm a dumb [UH-OH!]

@Lasercar
Copy link
Contributor

Lasercar commented Feb 1, 2025

Also, I just wanted to point out that funkin.assets should have the funkin PR template.

@Lasercar
Copy link
Contributor

Lasercar commented Feb 5, 2025

Just thought I mention, that this page: https://github.com/FunkinCrew/Funkin/labels is now quite handy for seeing how many issues there are of.

For example, there's about ~230 things tagged with the minor bug label, and ~230 tagged with the enhancement label.

That's, uh, a lot...

Also, while nearly everything has a tag now, there's still a lot of issues not categorized correctly, like reproduced bugs that don't have the bug reproduced label, or old issues that have probably been fixed not getting closed.

@sphis-Sinco
Copy link

My enhancement got mentioned here LMAO

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: github Relates to the management of issues and pull requests on GitHub.
Projects
None yet
Development

No branches or pull requests

5 participants