Skip to content
This repository has been archived by the owner on Nov 9, 2022. It is now read-only.

Latest commit

 

History

History
223 lines (156 loc) · 7.21 KB

CONTRIBUTING.md

File metadata and controls

223 lines (156 loc) · 7.21 KB
Raw

Contributing to smart-mastering-core

Smart-mastering-core welcomes new contributors. This document will guide you through the process.

Got a Question or Problem?

If you need help working with smart-mastering-core, please ask it on Stack Overflow with the "marklogic" tag.

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.

Want a Feature?

You can request a new feature by submitting an issue to our GitHub Issue Tracker. If you would like to implement a new feature then first create a new issue and discuss it with one of our project maintainers.

Submission Guidelines

Where To Start

If you're new to working on the Smart Mastering Core project, start by reviewing the module-level comments in the files that application developers should include to access the functionality, which are in src/main/ml-modules/root/com.marklogic.smart-mastering/

  • matcher.xqy find matches for a document
  • merging.xqy merge documents
  • process-records.xqy do both matching and merging

You'll also find function-level comments that explain the intent of the API functions. From there, follow the imports to the implementation libraries. They also have both module-level and function-level comments that will talk more about how the functionality is implemented.

Submitting an Issue

Before you submit your issue search the current issues to see whether your question or request has been addressed.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a stack trace helps
  • Motivation for or Use Case - explain why this is a bug for you
  • smart-mastering-core Version - is it a named version or from our dev branch
  • MarkLogic Version - the version of MarkLogic you're working with
  • Operating System - Mac, windows? details help
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

Submitting a Pull Request

Fork smart-mastering-core

Fork the project on GitHub and clone your copy.

$ git clone [email protected]:username/smart-mastering-core.git
$ cd smart-mastering-core
$ git remote add upstream git://github.com/marklogic-community/smart-mastering-core.git

All bug fixes and new features go into the develop branch.

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:

$ 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 8

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

We are working hard to improve smart-mastering-core's testing. If you add new functions in XQuery or JavaScript code then please write unit tests in the suites directory.

To deploy the code, including the tests, use this command:

$ gradle mlDeploy

When finished, verify that the self-test works. Make sure that all tests pass. Please, do not submit patches that fail.

Using Gradle
$ gradle mlUnitTest
Using the Test UI

Assuming the default configuration, point a browser to the test UI.

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.

Submit the pull request

Go to https://github.com/username/smart-mastering-core 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