Skip to content

Latest commit

 

History

History
245 lines (173 loc) · 6.51 KB

CONTRIBUTING.md

File metadata and controls

245 lines (173 loc) · 6.51 KB
Raw

Contributing to MarkLogic JDBC Driver

MarkLogic JDBC Driver welcomes new contributors. This document will guide you through the process.

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an issue to our GitHub Issue Tracker. Even better you can submit a Pull Request with a fix for the issue you filed.

Building the Driver from Source

Looking to build the code from source? Look no further.

Prerequisites

You need these to get started

  • MarkLogic 9.0-3+
  • Java 8 JDK
  • Gradle (3.4 or greater)
  • A decent IDE. IntelliJ is nice.

Building from the command line

cd /path/to/ml-jdbc-driver/
./gradlew build -x test

Troubleshooting

Do you have Gradle 3.4 or newer?

Using straight up gradle:

gradle -v

or if you are using the wrapper:

./gradlew -v

If your gradle wrapper is older than 3.4 then do this:

gradle wrapper --gradle-version 3.4

Are you on the develop branch?

hint: you should be
Check like so:

git branch

To switch to the develop branch:

git checkout develop

Do you have the latest code?

Better make sure...

You clone from the github.com/marklogic/ml-jdbc-driver repo
git pull origin develop
Your forked then cloned your fork

Make sure you have the upstream set:

$ git remote add upstream git://github.com/marklogic/ml-jdbc-driver.git

Then fetch the upstream:

git fetch upstream develop

Now merge it in:

git rebase upstream/develop

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. Please fill out the issue template so that your issue can be dealt with quickly.

Submitting a Pull Request

Fork ml-jdbc-driver

Fork the project on GitHub and clone your copy.

$ git clone [email protected]:username/ml-jdbc-driver.git
$ cd ml-jdbc-driver
$ git remote add upstream git://github.com/marklogic/ml-jdbc-driver.git

We ask that you open an issue in the issue tracker and get agreement from at least one of the project maintainers before you start coding.

Nothing is more frustrating than seeing your hard work go to waste because your vision does not align with that of a project maintainer.

Create a branch for your changes

Okay, so you have decided to fix something. Create a feature branch and start hacking. Note that we use git flow and thus our most recent changes live on the develop branch.

$ git checkout -b my-feature-branch -t origin/develop

Formatting code

We use .editorconfig to configure our editors for proper code formatting. If you don't use a tool that supports editorconfig be sure to configure your editor to use the settings equivalent to our .editorconfig file.

Commit your changes

Make sure git knows your name and email address:

$ git config --global user.name "J. Random User"
$ git config --global user.email "[email protected]"

Writing good commit logs is important. A commit log should describe what changed and why. Follow these guidelines when writing one:

  1. The first line should be 50 characters or less and contain a short description of the change including the Issue number prefixed by a hash (#).
  2. Keep the second line blank.
  3. Wrap all other lines at 72 columns.

A good commit log looks like this:

Fixing Issue #123: make the whatchamajigger work in MarkLogic

Body of commit message is a few lines of text, explaining things
in more detail, possibly giving some background about the issue
being fixed, etc etc.

The body of the commit message can be several paragraphs, and
please do proper word-wrap and keep columns shorter than about
72 characters or so. That way `git log` will show things
nicely even when it is indented.

The header line should be meaningful; it is what other people see when they run git shortlog or git log --oneline.

Rebase your repo

Use git rebase (not git merge) to sync your work from time to time.

$ git fetch upstream
$ git rebase upstream/develop

Test your code

Make sure the JUnit tests pass.

$ ./gradlew test

If you want to run a single test:

$ ./gradlew -Dtest.single=TestName test

for best results don't include the final word Test. Example: Say you want to run FlowRunnerTest.

$ ./gradlew -Dtest.single=FlowRunner test

Push your changes

$ git push origin my-feature-branch

Agree to the contributor License

Before we can merge your changes, you need to sign a Contributor License Agreement. You only need to do this once. This license is for your protection as well as the protection of MarkLogic and its licensees. This Agreement does not otherwise change your rights to use your own Contributions for any other purpose.

Submit the pull request

Go to https://github.com/username/ml-jdbc-driver and select your feature branch. Click the 'Pull Request' button and fill out the form.

Pull requests are usually reviewed within a few days. If you get comments that need to be to addressed, apply your changes in a separate commit and push that to your feature branch. Post a comment in the pull request afterwards; GitHub does not send out notifications when you add commits to existing pull requests.

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-feature-branch

  • Check out the develop branch:

    git checkout develop -f

  • Delete the local branch:

    git branch -D my-feature-branch

  • Update your develop with the latest upstream version:

    git pull --ff upstream develop