README.md in puppet-lint-optional_default-check-1.0.0 vs README.md in puppet-lint-optional_default-check-1.1.0
- old
+ new
@@ -1,10 +1,29 @@
puppet-lint-optional\_default-check
===================================
+[](https://github.com/voxpupuli/puppet-lint-optional_default-check/blob/master/LICENSE)
+[](https://github.com/voxpupuli/puppet-lint-optional_default-check/actions/workflows/test.yml)
+[](https://github.com/voxpupuli/puppet-lint-optional_default-check/actions/workflows/release.yml)
+[](https://rubygems.org/gems/puppet-lint-optional_default-check)
+[](https://rubygems.org/gems/puppet-lint-optional_default-check)
+[](#transfer-notice)
+
+
A puppet-lint plugin to check that `Optional` parameters don't default to something other than `undef`.
+## Table of contents
+
+* [Installing](#installing)
+ * [From the command line](#from-the-command-line)
+ * [In a Gemfile](#in-a-gemfile)
+* [Checks](#checks)
+* [Copyright](#copyright)
+* [Transfer notice](#transfer-notice)
+* [License](#license)
+* [Release Informaion](#release-information)
+
## Installing
### From the command line
```shell
@@ -59,10 +78,27 @@
Optional[Integer] $port = undef,
){
}
```
-# Copyright
+## Copyright
Copyright 2021 Alexander Fisher
-Licensed under the MIT License.
+## Transfer Notice
+
+This plugin was originally authored by [Alexander Fisher](https://github.com/alexjfisher).
+The maintainer preferred that [Vox Pupuli](https://voxpupuli.org/) take ownership of the module for future improvement and maintenance.
+Existing pull requests and issues were transferred, please fork and continue to contribute [here](https://github.com/voxpupuli/puppet-lint-optional_default-check) instead of on Alex's [fork](https://github.com/alexjfisher/puppet-lint-optional_default-check).
+
+## License
+
+This gem is licensed under the MIT license.
+
+## Release information
+
+To make a new release, please do:
+* Update the version in the `puppet-lint-optional_default-check.gemspec` file
+* Install gems with `bundle install --with release --path .vendor`
+* generate the changelog with `bundle exec rake changelog`
+* Create a PR with it
+* After it got merged, push a tag. A github workflow will do the actual release