alihan/fn-serverless
1
0
Fork 0
mirror of https://github.com/fnproject/fn.git synced 2022-10-28 21:29:17 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
605fe1eeccc8f2e0816b5cbcdc1105fb0f151117
fn-serverless/CONTRIBUTING.md
Benji Visser 7996fdb2ec Small doc fixes (#238) 
* adding instructions on how to test in docker for CONTRIBUTING.md

* fixing small grammatical issues

* adding documentation about how to run tests native

* all the sh!
2016-11-08 22:49:44 +01:00

822 B
Raw Blame History

Contributing to IronFunctions

We welcome all contributions!

How to contribute

  • Fork the repo
  • Fix an issue or create an issue and fix it
  • Create a Pull Request that fixes the issue
  • Sign the CLA
  • Good Job! Thanks for being awesome!

How to build and get up and running

Build

The first time after you fork or after dependencies get updated, run:

make dep

Then after every change, run:

make build

to build the functions binary.

Run

./functions

will start IronFunctions using an embedded Bolt database running on port 8080.

Test

make test

Run in Docker

make run-docker

will start IronFunctions inside a Docker container.

Tests in Docker

make test-docker

will test IronFunctions inside a Docker container.