Skip to content
This repository has been archived by the owner on Jun 7, 2023. It is now read-only.

Latest commit

 

History

History
30 lines (22 loc) · 1.12 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.12 KB
Raw

Contributing

Help is very welcome. Before making a Pull Request, ensure you have installed requirements and ran ./tools/hooks/autohook.sh install after initial checkout!

Requirements

buildifier

Buildifier can be installed with bazel or go.

Install with go

  1. change directory to $GOPATH
  2. run $ go get github.com/bazelbuild/buildtools/buildifier The executable file will be located under $GOPATH/bin
  3. create a soft link for global usage, run $ sudo ln -s $HOME/go/bin/buildifier /usr/bin/buildifier

Install with bazel

  1. clone bazelbuild/buildtools repository $ git clone https://github.com/bazelbuild/buildtools.git
  2. change directory to buildtools
  3. build it with bazel command, $ bazel build //buildifier The executable file will be located under path/to/buildtools/bazel-bin
  4. create a soft link

clang-format

clang-format can be installed by command:

  • Debian/Ubuntu based: $ sudo apt-get install clang-format
  • OSX: $ brew install clang-format