CONTRIBUTING.md

Contributor Guide

Prerequisites

To develop Emulsion, make sure you've installed the following tools:

• .NET SDK 8.0 or later,
• Node.js 18:
  • if you use nvm or [nvm-windows][], then run nvm use 18.

Build

Build the project using the following shell command:

$ dotnet build

Run

Run the application from sources using the following shell command:

$ dotnet run --project ./Emulsion [optional-path-to-json-config-file]

Test

Execute the tests using the following shell command:

$ dotnet test

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][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 "Emulsion contributors https://github.com/codingteam/emulsion" 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.)

Docker Publish

To build and push the container to Docker Hub, use the following shell commands:

$ docker build -t codingteam/emulsion:$EMULSION_VERSION \
    -t codingteam/emulsion:latest .

$ docker login # if necessary
$ docker push codingteam/emulsion:$EMULSION_VERSION
$ docker push codingteam/emulsion:latest

where $EMULSION_VERSION is the version of the image to publish.

Updating the Database Structure

If you want to update a database structure, you'll need to create a migration.

This article explains how to create a database migration using EFCore.FSharp.

1. Change the entity type (see Emulsion.Database/Entities.fs), update the EmulsionDbContext if required.

2. Run the following shell commands:

   $ dotnet tool restore
   $ cd Emulsion.Database
   $ dotnet ef migrations add <migration-name>

[nvm-windows]