Contribution Guidelines

Getting started

Recommended workflow

We recommend the following overall workflow when developing for this repository:

• Fork this repository
• Always work in your fork
• Always keep your fork up to date

Before updating your fork, run this command:

git remote add upstream https://github.com/nojaf/telplin.git

This will make management of multiple forks and your own work easier over time.

Updating your fork

We recommend the following commands to update your fork:

git checkout main
git clean -xdf
git fetch upstream
git rebase upstream/main
git push

Or more succinctly:

git checkout main && git clean -xdf && git fetch upstream && git rebase upstream/main && git push

This will update your fork with the latest from nojaf/telplin on your machine and push those updates to your remote fork.

Initial build

After cloning the repository, you can restore the local .NET tools:

dotnet tool restore

Next, you should run the build.fsx script. This will build the solution, run all unit tests and do everything that the CI build does.

dotnet fsi build.fsx

Documentation & Online tool

You can run dotnet fsi build.fsx -p Watch to launch the online tool (front-end & back-end) and the documentation.

• docs (fsdocs): http://localhost:7890/docs/index.html
• frontend (perla): https://localhost:8900
• backend (suave): http://localhost:8906

Pull request ground rules

• Code should be formatted before commiting: dotnet fantomas . -r
• Your local build needs to pass: dotnet fsi build.fsx
• Use proper pull request titles. Not Fixes #someNumber!
• Always aim to introduce the least amount of changes to achieve your goal.
• Write unit tests in the same style as the existing ones. The name should start with a lowercase letter!
• Ask questions when you are unsure 😸!