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
bc0b3c0031df8150f011c513571e949430228c5f
fn-serverless/CONTRIBUTING.md
James Jeffrey c7f3066c75 Update references remove refs to treeder oracle funcy (#376) 
* Remove lots of refs to iron and funcy oracle etc..

* more ref replacements

* Replacing more refs. Treeder

* Use Fn not FN
2017-09-29 16:22:15 -07:00

1.2 KiB
Raw Blame History

Contributing to Fn

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!

Documentation

When creating a Pull Request, make sure that you also update the documentation accordingly.

Most of the times, when making some behavior more explicit or adding a feature, a documentation update is necessary.

You will either update a file inside docs/ or create one. Prefer the former over the latter. If you are unsure, do not hesitate in open the PR with a comment asking for suggestions on how to address the documentation part.

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 run

to build and run the functions binary. It will start Functions using an embedded sqlite3 database running on port 8080.

Test

make test

Run in Docker

make docker-run

will start Functions inside a Docker container.

Tests in Docker

make docker-test

will test Functions inside a Docker container.