Skip to content
This repository has been archived by the owner on Aug 25, 2023. It is now read-only.

YACHT-1007: added contribution guide #48

Merged
merged 4 commits into from
Sep 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Contributing to BBQ

We welcome your patches and contributions to this project. This page describes
the few small guidelines we'll need you to follow.

## Following style guidelines and conventions

Our code is automatically checked and tested with [Travis CI](https://travis-ci.org/):
1. Code is automatically unit tested in Travis CI, see [build page](https://travis-ci.org/ocadotechnology/bbq),
1. Code coverage is analyzed using [Coveralls](https://coveralls.io/github/ocadotechnology/bbq?branch=master).

## Submitting a pull request

* All [pull requests](https://help.github.com/articles/about-pull-requests/) require a code review,
* Any merge conflicts needs to be resolved,
* All tests needs to pass before we will review your PR
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ BBQ (read: barbecue) is a python app that runs on Google App Engine (GAE) and cr
* [Backup process](#backup-process)
* [Restore process](#restore-process)
* [Retention process](#retention-process)

* [Usage](#usage)
* [Contributing](#contributing)

# Setup
To install BBQ in GCP, follow installation steps from [Setup.md](./SETUP.md) doc.
Expand Down Expand Up @@ -199,4 +199,14 @@ There are several options to restore data, available from _\<your-project-id>_._
* **restorationStatusEndpoint** - it shows all information about progress and each copy job.

We advise to use *restorationWarningsOnlyStatusEndpoint* for bigger datasets as the response time is quicker and response size smaller.

# Community

Subscribe or post to [backup-big-query@googlegroups.com](https://groups.google.com/forum/#!forum/backup-big-query) to follow along and ask questions about the BBQ.

# Contributing

Feel free to submit feature requests and bug reports under Issues.

If you would like to contribute to our development efforts, please review our [contributing guidelines](/CONTRIBUTING.md) and submit a pull request.