Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

73 lines (54 loc) · 2.29 KB

Contributor Guide

Building

Prerequisites

To build Cesium, install .NET 9 SDK or later.

Testing

Want to add new tests to Cesium? Read a separate document on tests.

There are two kinds of tests in Cesium: unit tests and integration tests.

Run the unit and integration tests using this shell command:

$ dotnet restore
$ dotnet nuke TestAll

Publishing

To produce a standalone compiler executable, run the following shell command:

dotnet publish Cesium.Compiler/Cesium.Compiler.csproj -r win-x64 --self-contained

Then navigate to Cesium.Compiler\bin\Debug\net7.0\win-x64\publish\ and that's your Cesium.

File Encoding Changes

If the automation asks you to update the file encoding (line endings or UTF-8 BOM) in certain files, run the following PowerShell script (PowerShell Core is recommended to run this script):

$ pwsh -File scripts/Test-Encoding.ps1 -AutoFix

The -AutoFix switch will automatically fix the encoding issues, and you'll only need to commit and push the changes.

License Automation

If the CI asks you to update the file licenses, follow one of these:

  1. Update the headers manually (look at the existing files), something like this: 
    // SPDX-FileCopyrightText: %year% %your name% <%your contact info, e.g. email%>
//
// SPDX-License-Identifier: MIT
    (accommodate to the file's comment style if required).
  2. Alternately, use REUSE tool: 
    $ reuse annotate --license MIT --copyright '%your name% <%your contact info, e.g. email%>' %file names to annotate%

(Feel free to attribute the changes to "Cesium contributors https://github.com/ForNeVeR/Cesium" instead of your name in a multi-author file, or if you don't want your name to be mentioned in the project's source: this doesn't mean you'll lose the copyright.)