github.com/vlifesystems/rulehunter@v0.0.0-20180501090014-673078aa4a83/CONTRIBUTING.md (about)

     1  Contributing to Rulehunter
     2  ==========================
     3  
     4  We would love contributions to improve this project.  You can help by reporting bugs, improving the documentation, submitting feature requests, fixing bugs, etc.
     5  
     6  Table of Contents
     7  -----------------
     8  
     9    * [Code](#code)
    10      * [Reporting Issues](#reporting-issues)
    11      * [Code Contributions](#code-contributions)
    12      * [Licence](#licence)
    13      * [Additional Licences and attribution](#additional-licences-and-attribution)
    14    * [Documentation](#documentation)
    15  
    16  Code
    17  ----
    18  Rulehunter is written in [Go](https://golang.org/) (v1.8+) and the code can be fetched with:
    19  
    20      go get github.com/vlifesystems/rulehunter
    21  
    22  Rulehunter uses [govendor](https://github.com/kardianos/govendor) to vendor dependencies and these are included in the repository's `vendor/` directory.
    23  
    24  ### Reporting Issues
    25  If you find a an issue with the code, please report it using the project's [issue tracker](https://github.com/vlifesystems/rulehunter/issues).  When reporting the issue please provide the version of Rulehunter (`rulehunter version`) and operating system being used.
    26  
    27  ### Code Contributions
    28  
    29  To submit code contributions we ask the following:
    30  
    31    * Confirm that your contributions can be included via a simple [Developer Certificate of Origin](#developer-certificate-of-origin) which we use instead of a full CLA. This can be signed via [cla-assistant](https://cla-assistant.io/vlifesystems/rulehunter).
    32    * Please put your changes in a separate branch to ease integration.
    33    * For new code please add tests to prove that it works.
    34    * Update [CHANGELOG.md](https://github.com/vlifesystems/rulehunter/blob/master/CHANGELOG.md) if appropriate.
    35    * Make a pull request to the [repo](https://github.com/vlifesystems/rulehunter) on github.
    36  
    37  #### Developer Certificate of Origin
    38  Rather than use a full-blown _Contributor License Agreement_, this project uses a simple _Developer Certificate of Origin_ to confirm that any contributions can be included.  The text of the certificate is listed below and the easiest way to confirm this is via [cla-assistant](https://cla-assistant.io/vlifesystems/rulehunter).
    39  
    40      Developer Certificate of Origin
    41      Version 1.1
    42  
    43      Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
    44      1 Letterman Drive
    45      Suite D4700
    46      San Francisco, CA, 94129
    47  
    48      Everyone is permitted to copy and distribute verbatim copies of this
    49      license document, but changing it is not allowed.
    50  
    51  
    52      Developer's Certificate of Origin 1.1
    53  
    54      By making a contribution to this project, I certify that:
    55  
    56      (a) The contribution was created in whole or in part by me and I
    57          have the right to submit it under the open source license
    58          indicated in the file; or
    59  
    60      (b) The contribution is based upon previous work that, to the best
    61          of my knowledge, is covered under an appropriate open source
    62          license and I have the right under that license to submit that
    63          work with modifications, whether created in whole or in part
    64          by me, under the same open source license (unless I am
    65          permitted to submit under a different license), as indicated
    66          in the file; or
    67  
    68      (c) The contribution was provided directly to me by some other
    69          person who certified (a), (b) or (c) and I have not modified
    70          it.
    71  
    72      (d) I understand and agree that this project and the contribution
    73          are public and that a record of the contribution (including all
    74          personal information I submit with it, including my sign-off) is
    75          maintained indefinitely and may be redistributed consistent with
    76          this project or the open source license(s) involved.
    77  
    78  
    79  ### Licence
    80  Copyright (C) 2016-2018 [vLife Systems Ltd](http://vlifesystems.com)
    81  
    82  Rulehunter is licensed under an MIT licence.  Please see [LICENSE.md](https://github.com/vlifesystems/rulehunter/blob/master/LICENSE.md) for details.
    83  
    84  ### Additional Licences and Attribution
    85  
    86  #### Twitter Boostrap
    87  
    88  [Twitter Boostrap](http://getbootstrap.com) has been included in the repository under `support/bootstrap`.
    89  
    90  Copyright 2011-2015 Twitter, Inc.
    91  
    92  Licensed under the MIT license.  For details see: [http://getbootstrap.com](http://getbootstrap.com).
    93  
    94  #### jQuery
    95  
    96  [jQuery](https://jquery.org) has been included in the repository under `support/jquery`.
    97  
    98  Copyright jQuery Foundation
    99  
   100  Licensed under the MIT license.  For details see [https://jquery.org/license/](https://jquery.org/license/).
   101  
   102  #### Html5 Shiv
   103  
   104  [Html5 Shiv](https://github.com/aFarkas/html5shiv) has been included in part in the repository under `support/html5shiv`
   105  
   106  Copyright (c) 2014 Alexander Farkas (aFarkas).
   107  
   108  This is dual licensed under the MIT and GPL version 2 licence.  For the sake of Rulehunter we will take it to be the MIT license as this matches the type of licence used by Rulehunter.  For details see the licence file in `support/html5shiv`.
   109  
   110  #### Respond
   111  
   112  [Respond](https://github.com/scottjehl/Respond) has been included in part in the repository under `support/respond`
   113  
   114  Copyright (c) 2013 Scott Jehl
   115  
   116  Licensed under the MIT license.  For details see the license file in `support/respond`.
   117  
   118  #### loading.io
   119  
   120  A loading icon called `ring.gif` has been included under `support/rulehunter/img`.  This came from the [loading.io](http://loading.io) website and their terms of uses state:
   121  
   122      All materials used in generating animated icons in this website, except the g0v icon, are created by loading.io. You can use them freely for any purpose.
   123  
   124  
   125  #### Vendored Go Packages
   126  
   127  This repository includes other packages in the `vendor/` directory.  Please see those packages for the licences that cover those works.
   128  
   129  
   130  Documentation
   131  -------------
   132  Documentation is really important to us and is kept centrally at [rulehunter.com](http://rulehunter.com). The content is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).
   133  
   134  If you want to help with this make a pull request to the [website repo](https://github.com/vlifesystems/rulehunter.com) on github. Please put any pull requests in a separate branch to ease integration.
   135  
   136  ### Reporting Issues
   137  If you find an issue with the documentation, please report it using the website's [issue tracker](https://github.com/vlifesystems/rulehunter.com/issues).