Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 1.31 KB

Contributing

We highly value and encourage contributions from the community!

Ignite is Apache 2.0 licensed and accepts contributions via GitHub Pull Requests.This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

We gratefully welcome improvements to documentation as well as to code.

Community and Access

Join [email protected] for calendar invites to calls and edit access to community documents.

We also hope to see you at our developer meetings.

Guidelines

TODO: Add contributing guidelines here after we formalize them.

Make targets

To compile the ignite binary, run

make

To compile the ignite-spawn binary and build the Docker image, run

make ignite-spawn

Before submitting a PR, run

make tidy

Other targets:

  • Install the ignite binary: make install
  • (Re)generate autogenerated content: make autogen
  • Generate dependency graph: make graph
    • Depends on sfdp (usually found in the graphviz package)
  • Push the weaveworks/ignite Docker image: make image-push