Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

65 lines (44 loc) · 1.93 KB
Raw

Contributing

Setup Development Prerequisites

Fork on GitHub

Before you do anything else, login on GitHub and fork this repository.

Clone Your Fork Locally

Install Git and clone your forked repository locally.

$ git clone https://github.com/<your-account>/libgsqlite

Play with Your Fork

Create a new feature branch and play with it.

$ git switch -c add-new-feature

The project uses Semantic Versioning 2.0.0, but you don't have to update Cargo.toml as I will maintain release.

Note: How to Update SQLite Binding

$ bindgen --default-macro-constant-type signed sqlite3ext.h -o sqlite3ext.rs

Test Your Fork

$ cargo test -- --skip test_extension

If you have (1) set up Google Cloud, and (2) created the sample spreadsheet as described in the README, you can run full test.

$ export LIBGSQLITE_GOOGLE_CLIENT_ID=...
$ export LIBGSQLITE_GOOGLE_CLIENT_SECRET=...
$ export LIBGSQLITE_GOOGLE_CLIENT_TEST_ID=https://docs.google.com/spreadsheets/d/...
$ export LIBGSQLITE_GOOGLE_CLIENT_TEST_SHEET=Sheet1
$ export LIBGSQLITE_GOOGLE_CLIENT_TEST_RANGE=A2:D7
$ cargo test

Open a Pull Request

  1. Commit your changes locally, rebase onto upstream/master, then push the changes to GitHub 
    $ git push origin add-new-feature
  2. Go to your fork on GitHub, switch to your feature branch, then click "Compare and pull request" button for review.

References