Add basic CONTRIBUTING.md

pull/398/head
Joe Nelson 2016-03-22 11:50:40 -07:00
parent d609325a44
commit da6e6608f6
2 changed files with 41 additions and 3 deletions

38
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,38 @@
# Contributing to Citus
We're happy you want to contribute! You can help us in different ways:
* Open an [issue](https://github.com/citusdata/citus/issues) with
suggestions for improvements
* Fork this repository and submit a pull request
### Getting and building
1. Install the following prerequisites, as necessary:
- A C compiler. On Mac OS X, Xcode should suffice.
- PostgreSQL development libraries
```bash
# on mac
brew install postgresql
# on linux
apt-get install libpq-dev
```
- Git 1.8+
2. Get the code
```bash
git clone https://github.com/citusdata/citus.git
```
3. Build and test
```bash
./configure
make
make install
make check
```

View File

@ -80,6 +80,6 @@ page](https://www.citusdata.com/citus-products/citus-data-pricing).
Citus is built on and of open source. We welcome your contributions,
and have added a
[helpwanted](https://github.com/citusdata/citus/labels/helpwanted) label
to issues which are accessible to new contributors. The CONTRIBUTING.md
file explains how to get started developing the Citus extension
itself and our code quality guidelines.
to issues which are accessible to new contributors. The
[CONTRIBUTING.md](CONTRIBUTING.md) file explains how to get started
developing the Citus extension itself and our code quality guidelines.