From 709a7c3b8adb37738f775dc04e46c2fdf38ec000 Mon Sep 17 00:00:00 2001 From: Beyang Liu Date: Wed, 3 Aug 2016 15:17:18 -0700 Subject: [PATCH] LICENSE and CONTRIBUTING.md --- CONTRIBUTING.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE | 26 +++++++++++++++++++++ 2 files changed, 88 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ffb8b91 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,62 @@ +# How to Contribute + +Sourcegraph projects are [MIT licensed](LICENSE) and accept 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. + +# Certificate of Origin + +By contributing to this project you agree to the Developer Certificate of Origin +(DCO). This document was created by the Linux Kernel community and is a simple +statement that you, as a contributor, have the legal right to make the +contribution. See the [DCO](DCO) file for details. + +## Getting Started + +- Fork the repository on GitHub +- Read the [README](README.md) for build and test instructions +- Play with the project, submit bugs, submit patches! + +## Contribution Flow + +This is a rough outline of what a contributor's workflow looks like: + +- Create a topic branch from where you want to base your work (usually master). +- Make commits of logical units. +- Make sure your commit messages are in the proper format (see below). +- Push your changes to a topic branch in your fork of the repository. +- Make sure the tests pass, and add any new tests as appropriate. +- Submit a pull request to the original repository. + +Thanks for your contributions! + +### Format of the Commit Message + +We follow a rough convention for commit messages that is designed to answer two +questions: what changed and why. The subject line should feature the what and +the body of the commit should describe the why. + +``` +scripts: add the test-cluster command + +this uses tmux to setup a test cluster that you can easily kill and +start for debugging. + +Fixes #38 +``` + +The format can be described more formally as follows: + +``` +: + + + +