Skip to content

Latest commit

 

History

History
76 lines (61 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

76 lines (61 loc) · 2.78 KB

How to Contribute

Around here, things are somewhat simple. All we ask is that you follow the basic rules and have common sense.

Basic Info

  • When you create a pull request to be merged into develop, please note that the rules will be heavily enforced. This is NOT because we want to be mean, but rather it's to make sure that FNF:JE has a good codebase. We don't want any contributors to deal with poorly put together code!
  • If you're looking for how to compile the game, please take a look at COMPILING.md!
  • If you're looking for how the project structure works, check out PROJECT.md!

Issues

If you wish to fix a bug, make an enhancement, or even wish to simply make a recommendation, then no worries! You can make an issue or create a sub-issue and help someone with something that needs to be worked on!

Important

Make sure to set the base branch to develop on your pull request, or otherwise it will NOT be merged and accepted!!

Comments & Formatting

Comments are very valuable because they allow you and other programmers to easily understand what is happening in your code.

However, sometimes they can be a hindrance as well.

If your comments have typos, aren't clear or concise, or just hard to understand in general, then they won't be any use. Even too many comments are unnecessary, since your code should be self documented and easily readable.

Formatting MUST match the configurations set in the editor config file, with the formatting based on the Google Java Style Guide.

Example of GOOD Comments (With Good Formatting)

/**
 * Plays a sound. (Duh.)
 *
 * @param path The path to play the sound from.
 * @return The sound instance itself, as a {@link FunkinSound}.
 */
public static FunkinSound playSound(String path) {
  FunkinSound sound = new FunkinSound(path);
  if (sound.ID != -1) { // libGDX will return -1 if the sound fails to play.
    soundPool.put(sound.ID, sound);
  }
  sound.play();
  return sound;
}

Example of BAD Comments (With Bad Formatting)

/**
 * ooohhhhhef idkk plays a sound igg??????
 *
 * @prm daPatyhh its da path to play der sound (iykyk :fire:)
 * @return tf you think vro :broken_heart:
 */
public static 
FunkinSound playSound  (String   
                                path) 
{
    // create da sound object duurrr
      FunkinSound sound =       new FunkinSound(path);
      // six seven
    if
    (sound.ID != -1){ // i have lito have no idea what this does :wilted_flower:
  soundPool.put(sound.ID, sound); // puts da sound in der sound pool :3
    }
sound.play(); // you already know dawg.
        return sound; // return the sound or whatever
}