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

[Hundrec]

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 and the reasons why they 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	#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.

Tip

If none of the above Issue templates suit your inquiry (e.g. Questions or Coding Help), please open a discussion.

Before You Submit...

Complete the Issue Checklist at the top of your template!

Important

If you do not complete each step of the Issue Checklist, your issue may be closed.

Be sure to 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 to keep track of important issues with the game.

Also only report one issue or enhancement at a time! If you have multiple bug reports or suggestions, split them up into separate submissions so they can be checked off one by one.

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

Thanks for contributing to the Funkin' GitHub!

[KoloInDaCrib]

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

[Lasercar]

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

[Hundrec]

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]

Add this info to this issue:

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

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]

Already included!

[Lasercar]

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]

Oh, he already pinned this

[Lasercar]

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

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

[Lasercar]

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

[Lasercar]

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]

My enhancement got mentioned here LMAO

[Lasercar]

@AbnormalPoof If a PR author doesn't respond to your request for a PR's merge conflicts to be solved within a month, you should consider pinging them like I'm doing right now for this message. That'll definitely get them to notice!

[Lasercar]

Oh, also, I just had I thought. There should be some kind of art label for all the art related issues and stuff (such as topic: art). It'd allow any contributors that either have skills in or specialise in art to more easily find them and fix them.