Skip to content

Jayman2000/simple-brick-breaker

Repository files navigation

Running from source

Prerequisites

Import and run

  1. Open Godot.
  2. In Godot’s Project Manager, click “Import”.
  3. Navigate to the project/ folder.
  4. Select project.godot.
  5. Click “Import & Edit”.
  6. Click on the playtest button that looks like this: ▶

Hints for contributors

  • Every file should declare its own copying information. See the comment at the top of COPYING.md for an example.

  • Use tabs for indentation. The only exception to this rule is in YAML files because YAML requires spaces for indentation. In YAML files, use 4 spaces for indentation.

  • The .pxo files are Pixelorama projects.

  • Before adding images to the project, I convert them into lossless WebPs using cwebp to make them smaller:

      cwebp input.png -o lossless output.webp
    

    Cwebp is from libwebp.

pre-commit

You can use pre-commit to automatically check your contributions.

  1. Open a terminal.
  2. Make sure that pre-commit is installed.
    1. Run pre-commit --version
    2. If it gives you an error, follow these instructions.
  3. cd to the root of this repo.
  4. Install pre-commit as a Git hook. To do so, run
    pre-commit install

At this point, whenever you run git commit, pre-commit will run a series of tests for the files that you modified.

There’s a few pre-commit hook failures that I’m OK with:

  • Some Markdown files fail one of pre-commit’s hooks, but only because one line is too long. I’m OK with that line being too long.

When I run into an error that I’m OK with, I skip the failing hooks for that commit.

Copying

See COPYING.md.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •