<commit_before># Coding Conventions

Updated: 5/3/2016

**Table of Contents**
<!-- BEGIN MUNGE: GENERATED_TOC -->

- [Coding Conventions](#coding-conventions)
  - [Code conventions](#code-conventions)
  - [Testing conventions](#testing-conventions)
  - [Directory and file conventions](#directory-and-file-conventions)
  - [Coding advice](#coding-advice)

<!-- END MUNGE: GENERATED_TOC -->

## Code conventions

  - Bash

    - https://google.github.io/styleguide/shell.xml

    - Ensure that build, release, test, and cluster-management scripts run on
OS X

  - Go

    - Ensure your code passes the [presubmit checks](development.md#hooks)

    - [Go Code Review
Comments](https://github.com/golang/go/wiki/CodeReviewComments)

    - [Effective Go](https://golang.org/doc/effective_go.html)

    - Comment your code.
      - [Go's commenting
conventions](http://blog.golang.org/godoc-documenting-go-code)
      - If reviewers ask questions about why the code is the way it is, that's a
sign that comments might be helpful.


    - Command-line flags should use dashes, not underscores
<commit_msg>fix link<commit_after># Coding Conventions

Updated: 5/3/2016

**Table of Contents**
<!-- BEGIN MUNGE: GENERATED_TOC -->

- [Coding Conventions](#coding-conventions)
  - [Code conventions](#code-conventions)
  - [Testing conventions](#testing-conventions)
  - [Directory and file conventions](#directory-and-file-conventions)
  - [Coding advice](#coding-advice)

<!-- END MUNGE: GENERATED_TOC -->

## Code conventions

  - Bash

    - https://google.github.io/styleguide/shell.xml

    - Ensure that build, release, test, and cluster-management scripts run on
OS X

  - Go

    - Ensure your code passes the [presubmit checks](development.md#define-a-pre-commit-hook)

    - [Go Code Review
Comments](https://github.com/golang/go/wiki/CodeReviewComments)

    - [Effective Go](https://golang.org/doc/effective_go.html)

    - Comment your code.
      - [Go's commenting
conventions](http://blog.golang.org/godoc-documenting-go-code)
      - If reviewers ask questions about why the code is the way it is, that's a
sign that comments might be helpful.


    - Command-line flags should use dashes, not underscores

{'fraction_non_alphanumeric': 0.12658227848101267, 'fraction_numerical': 0.0054249547920434, 'mean_word_length': 3.479757085020243, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 2}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5094747', 'n_tokens_mistral': 748, 'n_tokens_neox': 664, 'n_words': 181}