Merge pull request #174 from muskie9/pull/docsV4#169

DOCS update module docs

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+## Affected Version
+
+Show version numbers by pasting the output of `composer info --direct`.
+Alternatively, get the framework version information from the CMS.
+In SilverStripe 4.3 and newer you may find the Help menu in the bottom left corner, unfold it and hover over the version number to get the information.
+Otherwise, simply hover over the SilverStripe logo in the bottom left corner of the CMS.
+
+## Description
+
+Describe expected and observed behaviour.
+For visual issues, please include browser version and screenshots.
+Please read [our contributing docs](../CONTRIBUTING.md).
+
+## Steps to Reproduce
+
+Help us with step-by-step instructions.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+Thanks for contributing, you're awesome! :star:
+Please describe expected and observed behaviour, and what you're fixing.
+For visual fixes, please include tested browsers and screenshots.
+Search for related existing issues and link to them if possible.
+Please read [our contributing docs](../CONTRIBUTING.md).

CONTRIBUTING.md

@@ -1,3 +1,14 @@
 # Contributing
+- Maintenance on this module is a shared effort of those who use it
+- To contribute improvements to the code, ensure you raise a pull request and discuss with the module maintainers
+- Please follow the SilverStripe [code contribution guidelines](https://docs.silverstripe.org/en/contributing/code/) and [Module Standard](https://docs.silverstripe.org/en/developer_guides/extending/modules/#module-standard)
+- Supply documentation that followS the [GitHub Flavored Markdown](https://help.github.com/articles/markdown-basics/) conventions
+- When having discussions about this module in issues or pull request please adhere to the [SilverStripe Community Code of Conduct](https://docs.silverstripe.org/en/contributing/code_of_conduct/)
 
-Contributions are welcome! Create an issue, explaining a bug or proposal. Submit pull requests if you feel brave.
+
+## Contributor license agreement
+By supplying code to this module in patches, tickets and pull requests, you agree to assign copyright 
+of that code to Dynamic, on the condition that these code changes are released under the 
+same BSD license as the original module. We ask for this so that the ownership in the license is clear 
+and unambiguous. By releasing this code under a permissive license such as BSD, this copyright assignment 
+won't prevent you from using the code in any way you see fit.

LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Dynamic
+Copyright (c) 2019, Dynamic
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
@@ -9,4 +9,4 @@ Redistribution and use in source and binary forms, with or without modification,
 
 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -22,17 +22,7 @@ The FlexSlider module allows a developer to attach a [Woothemes FlexSlider](http
 
 ## Installation
 
-`composer require dynamic/flexslider ^3.0`
-
-## Example usage
-
-FlexSlider displays an image slide show using the FlexSlider jQuery plugin. In the CMS you can specify a number of display options, including auto-animate, slide or fade, and loop.
-
-![screen shot](images/FlexSlider.png)
-
-## Pre-Release Migration Task
-
-We've added some additional configuration options since the 1.0.0 pre-releases. To update all of your existing FlexSliders with the new default values, run `dev/tasks/SlideThumbnailNavMigrationTask`.
+`composer require dynamic/flexslider ^4.0`
 
 ## Documentation
 
@@ -42,8 +32,25 @@ See the [docs/en](docs/en/index.md) folder.
 
 - I've applied the `FlexSlider` DataExtension to a DataObject or Page and am receiving errors.
   - Be sure you have run a `dev/build?flush=all`
-  - If this is an existing site installation and `FlexSlider` is being applied to existing records, be sure to run `dev/tasks/SlideThumbnailNavMigrationTask`. This will ensure default values expeceted for the module are setup for the existing records.
+  - If this is an existing site installation and `FlexSlider` is being applied to existing records, be sure to run `dev/tasks/SlideThumbnailNavMigrationTask`. This will ensure default values expected for the module are setup for the existing records.
+
+## Bugtracker
+Bugs are tracked in the issues section of this repository. Before submitting an issue please read over 
+existing issues to ensure yours is unique. 
+
+If the issue does look like a new bug:
+
+ - Create a new issue
+ - Describe the steps required to reproduce your issue, and the expected outcome. Unit tests, screenshots 
+ and screencasts can help here.
+ - Describe your environment as detailed as possible: SilverStripe version, Browser, PHP version, 
+ Operating System, any installed SilverStripe modules.
+
+Please report security issues to the module maintainers directly. Please don't file security issues in the bugtracker.
 
 ## Maintainer Contact
 
  *  [Dynamic](http://www.dynamicagency.com) (<dev@dynamicagency.com>)
+
+## License
+See [License](license.md)

code-of-conduct.md

@@ -0,0 +1 @@
+When having discussions about this module in issues or pull request please adhere to the [SilverStripe Community Code of Conduct](https://docs.silverstripe.org/en/contributing/code_of_conduct).