From 29b976c1ed55cf8055a4df0ccdd7a50bd5052855 Mon Sep 17 00:00:00 2001 From: Sasha Klizhentas Date: Tue, 29 Nov 2016 15:56:30 -0800 Subject: [PATCH] Add contributing guidelines --- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..65a877df259 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +### Contributing A Patch + +If you're working on an existing issue, such as one of the `help-wanted` ones +above, simply respond to the issue and express interest in working on it. This +helps other people know that the issue is active, and hopefully prevents +duplicated efforts. + +If you want to work on a new idea of relatively small scope: + +1. Submit an issue describing your proposed change to the repo in question. +1. The repo owners will respond to your issue promptly. +1. If your proposed change is accepted, fork the repo, develop, and test your changes. +1. Submit a pull request. + +If you want to work on a bigger idea, submit an issue describing your proposed design. + +### Adding dependencies + +If your patch depends on new packages, add that package with +[`godep`](https://github.com/tools/godep). Follow the [instructions to add a +dependency](docs/devel/development.md#godep-and-dependency-management). +