Contributor Onboarding

The goal of this document is to help folks who want to contribute to the Azure Functions host (aka azure-webjobs-sdk-script).

🚧 This document is still a WIP 🚧

General

• The host is currently going through a redesign for v2 which moves it onto .NET core and move languages out into their own separate repos. These guidelines are generally written for the work going on in dev which is v2. The master branch and a few others are still v1 and have a different workflow.
• The host has some dependencies on having some Azure resources provisioned, so before you get started, make sure you have reliable access to an Azure subscription. E2E tests require a lot of various services to be provisioned. If you're making large contributions which would affect E2E tests, it'll be expected that you can provision those services yourself.

Pre-reqs

• OS
  • Windows 10 (suggested)
  • Mac OS X/Linux (not-recommended for now)
    • While you can develop from a Mac/Linux machine, it can be a rough experience and not all unit tests pass today. We have improvements where we hope to make this easier.
• Language runtimes
  • Note: today you have to have Node.js and Java installed, but in the long run we hope move those tests out into their own repos
  • Java 8 (JDK and JRE required)
  • Node 8.4+
  • .NET Core 2.0