dolt/CONTRIBUTING.md

Contributing to Noms

License

Noms is open source software, licensed under the Apache License, Version 2.0.

Contributing code

Due to legal reasons, all contributors must sign a contributor license agreement, either for an individual or corporation, before a pull request can be accepted.

Languages

• Use Go, JS, or Python.
• Shell script is not allowed.

Coding style

• Go uses gofmt, advisable to hook into your editor
• JS follows the Airbnb Style Guide
• Tag PRs with either toward: #<bug> or fixes: #<bug> to help establish context for why a change is happening
• Commit messages follow Chris Beam's awesome commit message style guide

Running the tests

You can use go test command, e.g:

• go test $(go list ./... | grep -v /vendor/) should run every tests except from vendor packages.

For JS code, We have a python script to run all js tests.

• python tools/run-all-js-tests.py

Recommended Chrome extensions

• Hides generated (Go) files from GitHub pull requests: GitHub PR gen hider.