Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.5 KB
Raw

Contributing to SMQTK

Here we describe at a high level how to contribute to SMQTK. See the SMQTK README file for additional information.

The General Process

  1. The official SMQTK source is maintained on GitHub

  2. Fork SMQTK into your user's namespace on GitHub and clone this repository on your system.

    • Optionally build SMQTK to use packaged versions of libSVM and FLANN. See the build instructions for more details.

  3. Create a topic branch, edit files and create commits:

    $ git checkout -b <branch-name>
$ <edit things>
$ git add <file1> <file2> ...
$ git commit

  4. Push topic branch with commits to your fork in GitHub:

    $ git push origin HEAD -u

  5. Visit the Kitware SMQTK page on GitHub, browse to the "Pull requests" tab and click on the "New pull request" button in the upper-right. Click on the "compare across forks" link, browse to your fork and browse to the topic branch to submit for the pull request. Finally, click the "Create pull request" button to create the request.

SMQTK uses GitHub for code review and Travis-CI for continuous testing as new pull requests are made. All checks/tests must pass before a PR can be merged.

Sphinx is used for manual and automatic API documentation.