Skip to content

Latest commit

 

History

History
108 lines (68 loc) · 3.06 KB

CONTRIBUTING.md

File metadata and controls

108 lines (68 loc) · 3.06 KB
Raw

Contributing

Any contributions to the JamJar game engine are welcome, please review our Code of Conduct before making a contribution.

Raising an Issue

Please follow one of the following templates for raising an issue against this project.

Bug Report

Please use the bug report template for reporting a bug.

Feature Request

Please use the feature request template for requesting a new feature.

Requesting Help

Please use the discussions to raise any requests for help or general queries.

Developing

Any code contributions are also welcome, please pick up an issue, if you can comment on it to reduce the chance of duplicated effort that would be great.

Dependencies

The project has the following dependencies:

  • cmake == 3.22.1
  • clang == 11.0.0
  • clang-tidy == 11.0.0
  • clang-format == 11.0.0
  • emscripten == 3.1.1

Later minor and patch versions of these dependencies should still work, the CI build just uses the versions above.

To view the docs locally, the project requires:

  • python == 3.8.11

To install the required pip dependencies to view the docs locally, run:

pip install -r docs/requirements.txt

Starting

Outlined below are some steps for beginning development on different environments. These are not exhaustive, and only show the absolute basics for getting set up.

Linux/MacOS

First install the dependencies listed in the dependencies section, then you can run the following command to generate the build system:

emcmake cmake -D CMAKE_EXPORT_COMPILE_COMMANDS=ON . -B build

This command will generate some build files in the build/ directory, inside which you can run:

emmake make

This will generate the build/libJamJar.a library archive which can be used when building game executables.

Running unit tests

The unit tests run locally, not in the browser after compiling with emscripten. This means that they need to be built either with GCC or clang, you can do that by removing the build/ directory, then running this command:

cmake -D CMAKE_EXPORT_COMPILE_COMMANDS=ON . -B build

This command will generate the build files for GCC/Clang in the build/ directory, inside which you can run;

make JamJarTests

Then you can run the unit tests by running the following in the build/ directory:

ctest
Skipping unit test compilation

You can skip compiling unit tests by running this as your build system generation command:

emcmake cmake -D JAMJAR_NATIVE_COMPILE_UNIT_TESTS=OFF -D CMAKE_EXPORT_COMPILE_COMMANDS=ON -B build .

Targets

The cmake is set up to provide a couple useful targets:

  • beautify - runs clang-format against the codebase, must be run to pass the CI.
  • lint - runs clang-tidy against the codebase, must be run to pass the CI.
  • lint_fix - runs clang-tidy against the codebase and will attempt to fix the code (this may break things).
  • serve_docs - hosts the docs locally on http://localhost:8000.