Contributing to FAKE

This page should provide you with some basic information if you're thinking about contributing to FAKE.

  • This page can be edited by sending a pull request to the FAKE project on GitHub, so if you learn something when playing with FAKE please record your findings here!

  • If you want to discuss a feature (a good idea!), or if you want to look at suggestions how you might contribute, check out:

  • Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the Project shall be under the terms and conditions of the Apache 2.0 license. See License.txt for details.
  • TLDR: Send a pull request with either documentation (/help folder) or code changes.

Documentation

The documentation for FAKE is automatically generated using the amazing F# Formatting library. It turns *.md (Markdown with embedded code snippets) and *.fsx files (F# script file with embedded Markdown documentation) into a nice HTML documentation.

  • The code for all the documents can be found in the help directory on GitHub. If you find a bug or add a new feature, make sure you document it!

  • If you want to build the documentation, simply run the build script (GitHub link) which builds the documentation.

Creating pull requests

Prerequisites

Git / GitHub

Build tools

Programming

  • Checkout the master branch.

  • Run the build via fake run build.fsx in order to check if everything works.

  • Create a new feature branch.

    
    git checkout -b myfeature
    
    

  • Implement your bugfix/feature.
  • Add a bit of documentation (see above).
  • Run the build script again, to confirm that all tests pass.
  • Commit and push to your fork.
  • Use GitHub's UI to create a pull request. Write "WIP" into the pull request description if it's not completely ready

  • If you need to rebase you can do:

    
    git fetch upstream
    git rebase upstream/master
    git push origin myfeature -f
    
    

  • The pull request will be updated automatically.

A note on module testing

  • If you make a change to a module and would like to test it in a fake script, the easiest way to do this is to create a local nuget package and reference it in your script. To do this, follow the steps below
  • Create a local nuget package for the module you've changed.
    e.g: Using dotnet cli

    
    cd path/to/project
    dotnet pack
    
    

  • Dotnet pack will create a default nuget package with version of 1.0.0 in the bin/Debug of your project. Set an additional paket source in your build script to this directory, and require this exact version in your paket references

    e.g: If you wanted to test a local build of Fake.DotNet.NuGet

    1: 
    2: 
    3: 
    4: 
    5: 
    
     #r "paket: 
     source path/to/Fake.DotNet.NuGet/bin/Debug/
     source https://api.nuget.org/v3/index.json
     ...Other Dependencies...
     nuget Fake.DotNet.NuGet == 1.0.0 //" //Require version 1.0.0, which is the local build
    

Staging environment

In order to test and preview our changes faster we have a fully automated release process in place. This staging environment is based on VSTS and MyGet.

If you ever need a release/bugfix fast, make sure to mention that in your PR, we can quickly provide a build on the following infrastructure:

INFO
Because of package retention policies those builds will not be available forever! We will quickly release the builds once everything works. Those bits should be considered for "unblocking"-purposes or testing only.

General considerations

  • Fake 4 (FakeLib) is in maintainance mode. Therefore new features need to be at least available as new FAKE 5 module (that might mean that the old module needs to be migrated as part of the PR).
  • Fake 4 still allows hotfixes, please send the PR against the https://github.com/fsharp/FAKE/tree/hotfix_fake4

    It would be helpful if a second PR against master is sent which merges the hotfix into master and adds the hotfix to the FAKE 5 code as well.

Text editor / Code style

"Testing" Documentation locally

  • fake build target GenerateDocs to build everything including the documentation or fake build -s target GenerateDocs to only build the docs (assumes binaries are already build and not modified)
  • fake build target HostDocs spins up a webserver for the documentation folder and opens the browser.

API-Design

We learned from our mistakes, so we use the following guidelines, please read them very carefully (ask if you don't understand any rule):

  • AutoOpen is no longer used

  • We replace <verb><module> functions with <module>.<verb>

    • Use Verbs as much as possible for functions
    • In order, to have a more consistent API we propose to always use camelCase naming for functions
    • For historic reasons we allow constants and values in PascalCase (they will not have a "verb" as they don't do anything)
    • If we provide optional parameters (via static member) we use PascalCase as well (Example: Shell-module)

  • We assume the caller is not opening the module but only the global namespaces Fake.Core, Fake.IO, ... and make sure the code looks nice and structured on the caller side.

  • For compatibility reasons (migration from legacy). We assume the user doesn't open the global Fake namespace.

    -> This means we don't add anything in there in the new API.

  • Old APIs are marked as Obsolete with a link (hint) to the new API location. We use codes to make explicit

    • FAKE0001 for moving part from one Module to another
    • FAKE0002 for removed API we don't know who is using it and how => please open an issue if you use it
    • FAKE0003 for API that is no more accessible (basically became internal) => please open an issue if you use it
    • FAKE0004 for API not yet migrated, waiting for your contribution
  • Operators are opened seperatly with a separate Operators module

  • We avoid the Helpers suffix (because we now expect users to write <module>.<function>)

  • We generally use the RequireQualifiedAccess attribute on modules.

Guidelines

  • Add documentation for your feature
  • If you add new markdown documentation make sure to link if from an existing site, ideally add it to the menu
  • If you write API-Documentation but no extra markdown please consider adding it to the menu as well.

Porting a module to FAKE 5

As mentioned in the "Fake 5 learn more" section we have a large list to choose from to help the project. One of these things is porting modules to FAKE 5. To save you from some pitfalls this sections guides you in migrating modules with an (at least for me) working approach.

Tooling in netcore it not optimal yet so some things have to be done by hand, but with these steps you have pretty good IDE support:

  • Copy one of the existing netcore projects and edit the project file by hand (rename)
  • Copy the old implementation files from src/app/FakeLib to /src/app/Fake.<ModuleType>.<Name> (update project file again if required)
  • Reference the new files in FakeLib (again updating FakeLib.fsproj by hand to properly reference the stuff)
  • Open Fake.sln and go from there. Because in F# you can only reference stuff defines in files ABOVE, this is ALMOST perfect
  • Once stuff compiles in the (Fake.sln) solution the remaining changes to make the netcore project compile are usually straightforward (you basically only need to fix project references or add framework nuget packages if needed). Let us know if you struggle at this point (in the PR or a new issue).
  • Add the info about the new module to the dotnetAssemblyInfos variable in build.fsx. From this point on the build script will let you know if anything is missing. Again, if you have problems let us know.
  • Mark the old module with the Obsolete attribute.
    INFO
    src/Fake-netcore.sln is currently not used (as IDEs don't support that yet). However it is used so speed up the build, fake run build.fsx will let you know what to do in the error message.

These steps will ensure:

  • People using the NuGet package will get the warnings to update the new API
  • The new API is part of FakeLib (deprecated)
  • The new API is available as separate module