REFACTOR update composer, README, docs

CONTRIBUTING.md

@@ -0,0 +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/)
+
+
+## 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,5 @@
-Copyright <YEAR> <COPYRIGHT HOLDER>
+Copyright (c) 2023, 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:
 

README.md

@@ -1,17 +1,28 @@
 # SilverStripe User Invitation
 
-[![Build Status](https://scrutinizer-ci.com/g/FSWebWorks/silverstripe-user-invitation/badges/build.png?b=master)](https://scrutinizer-ci.com/g/FSWebWorks/silverstripe-user-invitation/build-status/master)
-[![scrutinizer](https://scrutinizer-ci.com/g/fswebworks/silverstripe-user-invitation/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/fswebworks/silverstripe-user-invitation/)
-[![Code Coverage](https://codecov.io/gh/fswebworks/silverstripe-user-invitation/branch/master/graph/badge.svg)](https://codecov.io/gh/fswebworks/silverstripe-user-invitation)
-[![License](http://img.shields.io/packagist/l/fswebworks/silverstripe-user-invitation.svg?style=flat-square)](LICENSE.md)
+This module adds the ability to invite users to a secure website (e.g. Intranet or Extranet).
 
-## Introduction
+[![CI](https://github.com/dynamic/silverstripe-user-invitation/actions/workflows/ci.yml/badge.svg)](https://github.com/dynamic/silverstripe-user-invitation/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/dynamic/silverstripe-user-invitation/branch/master/graph/badge.svg)](https://codecov.io/gh/dynamic/silverstripe-user-invitation)
 
-This module adds the ability to invite users to a secure website (e.g. Intranet or Extranet).
+[![Latest Stable Version](https://poser.pugx.org/dynamic/silverstripe-user-invitation/v/stable)](https://packagist.org/packages/dynamic/silverstripe-user-invitation)
+[![Total Downloads](https://poser.pugx.org/dynamic/silverstripe-user-invitation/downloads)](https://packagist.org/packages/dynamic/silverstripe-user-invitation)
+[![Latest Unstable Version](https://poser.pugx.org/dynamic/silverstripe-user-invitation/v/unstable)](https://packagist.org/packages/dynamic/silverstripe-user-invitation)
+[![License](https://poser.pugx.org/dynamic/silverstripe-user-invitation/license)](https://packagist.org/packages/dynamic/silverstripe-user-invitation)
 
 ## Requirements
 
- * SilverStripe 3.6+
+ * silverstripe/framework ^4
+
+ ## Installation
+
+```
+composer require dynamic/silverstripe-user-invitation
+```
+
+## License
+
+See [License](LICENSE.md)
 
 ## Features
 
@@ -24,7 +35,7 @@ This module adds the ability to invite users to a secure website (e.g. Intranet
 ### Force required user group assignment
 Place the following in your mysite/_config/config.yml
 ```yml
-FSWebWorks\SilverStripe\UserInvitations\Model\UserInvitation:
+Dynamic\SilverStripe\UserInvitations\Model\UserInvitation:
     force_require_group: true
 ```
 
@@ -41,16 +52,23 @@ public function updateMainTemplates(&$mainTemplates)
 }
 ```
 
-## Installation
+## Maintainers
 
- ```sh
- $ composer require fswebworks/silverstripe-user-invitation
- ```
+ *  [Dynamic](https://www.dynamicagency.com) (<dev@dynamicagency.com>)
 
-## Maintainer
+## 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.
 
-Franco Springveldt - franco@fswebworks.co.za
+If the issue does look like a new bug:
 
-## License
+ - 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.
 
-This module is licensed under the [MIT license](LICENSE).
+## Development and contribution
+If you would like to make contributions to the module please ensure you raise a pull request and discuss with the module maintainers.

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).

composer.json

@@ -1,5 +1,5 @@
 {
-    "name": "fswebworks/silverstripe-user-invitation",
+    "name": "dynamic/silverstripe-user-invitation",
     "description": "A SilverStripe module to handle user invitations to your secure website.",
     "license": "BSD-3-Clause",
     "type": "silverstripe-vendormodule",
@@ -11,24 +11,38 @@
         {
             "name": "Franco Springveldt",
             "email": "franco@fswebworks.co.za"
+        },
+        {
+            "name": "Dynamic",
+            "email": "dev@dynamicagency.com",
+            "homepage": "https://www.dynamicagency.com"
         }
     ],
     "require": {
-        "silverstripe/framework": "^4 || ^5"
+        "silverstripe/framework": "^4"
     },
     "require-dev": {
-        "silverstripe/recipe-testing": "^2 || ^3"
+        "silverstripe/recipe-testing": "^2"
     },
-    "minimum-stability": "stable",
+    "minimum-stability": "dev",
+    "prefer-stable": true,
     "autoload": {
         "psr-4": {
-            "FSWebWorks\\SilverStripe\\UserInvitations\\": "src/",
-            "FSWebWorks\\SilverStripe\\UserInvitations\\Tests\\": "tests/php/"
+            "Dynamic\\UserInvitations\\": "src/",
+            "Dynamic\\UserInvitations\\Test\\": "tests/php/"
         }
     },
+    "config": {
+        "allow-plugins": {
+            "composer/installers": true,
+            "silverstripe/vendor-plugin": true,
+            "silverstripe/recipe-plugin": true
+        },
+        "process-timeout": 600
+    },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.0.x-dev"
+            "dev-main": "1.x-dev"
         }
     }
 }

phpcs.xml.dist

@@ -5,6 +5,7 @@
     <file>src</file>
     <file>tests</file>
 
+    <!-- base rules are PSR-2 -->
     <rule ref="PSR2" >
         <!-- Current exclusions -->
         <exclude name="PSR1.Methods.CamelCapsMethodName" />

phpunit.xml.dist

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/silverstripe/framework/tests/bootstrap.php" colors="true">
+<phpunit bootstrap="vendor/silverstripe/cms/tests/bootstrap.php" colors="true">
     <testsuites>
         <testsuite name="Default">
-            <directory>tests</directory>
+            <directory>tests/</directory>
         </testsuite>
     </testsuites>
     <filter>