Merge pull request #24 from dell/ansible-community-inclusion

Added changes for ansible community inclusion

Author: Jennifer-John

README.md

@@ -4,6 +4,23 @@ The Ansible Modules for Dell Technologies (Dell) Unity allow Data Center and IT
 
 The capabilities of the Ansible modules are managing consistency groups, filesystem, filesystem snapshots, CIFS server, NAS server, NFS server, NFS export, SMB share, interface, hosts, snapshots, snapshot schedules, storage pools, user quotas, quota trees and volumes. Capabilities also include gathering facts from the array. The options available for each are list, show, create, modify and delete. These tasks can be executed by running simple playbooks written in yaml syntax. The modules are written so that all the operations are idempotent, so making multiple identical requests has the same effect as making a single request.
 
+## Table of contents
+
+* [Code of conduct](https://github.com/dell/ansible-unity/blob/1.4.1/docs/CODE_OF_CONDUCT.md)
+* [Maintainer guide](https://github.com/dell/ansible-unity/blob/1.4.1/docs/MAINTAINER_GUIDE.md)
+* [Committer guide](https://github.com/dell/ansible-unity/blob/1.4.1/docs/COMMITTER_GUIDE.md)
+* [Contributing guide](https://github.com/dell/ansible-unity/blob/1.4.1/docs/CONTRIBUTING.md)
+* [Branching strategy](https://github.com/dell/ansible-unity/blob/1.4.1/docs/BRANCHING.md)
+* [List of adopters](https://github.com/dell/ansible-unity/blob/1.4.1/docs/ADOPTERS.md)
+* [Maintainers](https://github.com/dell/ansible-unity/blob/1.4.1/docs/MAINTAINERS.md)
+* [Support](https://github.com/dell/ansible-unity/blob/1.4.1/docs/SUPPORT.md)
+* [License](#license)
+* [Security](https://github.com/dell/ansible-unity/blob/1.4.1/docs/SECURITY.md)
+* [Prerequisites](#prerequisites)
+* [List of Ansible modules for Dell Unity](#list-of-ansible-modules-for-dell-unity)
+* [Installation](#installing-collections)
+* [Releasing, Maintenance and Deprecation](#releasing-maintenance-and-deprecation)
+
 ## License
 The Ansible collection for Unity is released and licensed under the GPL-3.0 license. See [LICENSE](https://github.com/dell/ansible-unity/blob/1.4.1/LICENSE) for the full terms. Ansible modules and module utilities that are part of the Ansible collection for Unity are released and licensed under the Apache 2.0 license. See [MODULE-LICENSE](https://github.com/dell/ansible-unity/blob/1.4.1/MODULE-LICENSE) for the full terms.
 
@@ -16,7 +33,7 @@ The Ansible collection for Unity is supported by Dell and is provided under the
 ## Prerequisites
 This table provides information about the software prerequisites for the Ansible Modules for Dell Unity.
 
-| **Ansible Modules** | **Red Hat Enterprise Linux** | **Python version** | **Python library version** | **Ansible** |
+| **Ansible Modules** | **Red Hat Enterprise Linux** | **Python version** | **Storops - Python SDK version** | **Ansible** |
 |---------------------|------------------------------|--------------------|----------------------------|-------------|
 | v1.4.1 | 8.4 <br> 8.5| 3.8 <br> 3.9 <br> 3.10 | 1.2.11 | 2.11 <br> 2.12 <br> 2.13|
 
@@ -127,5 +144,12 @@ Ansible can also be installed in a container environment. Ansible Builder provid
 
         docker run --rm -v $(pwd):/runner <tag_name> ansible-playbook info_tests.yml
 
-## Maintanence
-Ansible Modules for Dell Technologies Unity deprecation cycle is aligned with [Ansible](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html).
+## Releasing, Maintenance and Deprecation
+
+Ansible Modules for Dell Technnologies Unity follows [Semantic Versioning](https://semver.org/).
+
+New version will be release regularly if significant changes (bug fix or new feature) are made in the collection.
+
+Released code versions are located on "release" branches with names of the form "release-x.y.z" where x.y.z corresponds to the version number. More information on branching strategy followed can be found [here](https://github.com/dell/ansible-unity/blob/1.4.1/docs/BRANCHING.md).
+
+Ansible Modules for Dell Technologies Unity deprecation cycle is aligned with that of [Ansible](https://docs.ansible.com/ansible/latest/dev_guide/module_lifecycle.html).

docs/ADOPTERS.md

@@ -0,0 +1,11 @@
+<!--
+Copyright (c) 2022 Dell Inc., or its subsidiaries. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+-->
+
+# List of adopters

docs/BRANCHING.md

@@ -0,0 +1,32 @@
+<!--
+Copyright (c) 2022 Dell Inc., or its subsidiaries. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+-->
+
+# Branching strategy
+
+Ansible modules for Dell Unity follows a scaled trunk branching strategy where short-lived branches are created off of the main branch. When coding is complete, the branch is merged back into main after being approved in a pull request code review.
+
+## Branch naming convention
+
+|  Branch Type |  Example                          |  Comment                                  |
+|--------------|-----------------------------------|-------------------------------------------|
+|  master      |  master                           |                                           |
+|  Release     |  release-1.0                      |  hotfix: release-1.1 patch: release-1.0.1 |
+|  Feature     |  feature-9-vol-support            |  "9" referring to GitHub issue ID         |
+|  Bug Fix     |  bugfix-110-fix-duplicates-issue  |  "110" referring to GitHub issue ID       |
+
+
+## Steps for working on a release branch
+
+1. Fork the repository.
+2. Create a branch off of the master branch. The branch name should follow [branch naming convention](#branch-naming-convention).
+3. Make your changes and commit them to your branch.
+4. If other code changes have merged into the upstream master branch, perform a rebase of those changes into your branch.
+5. Open a [pull request](https://github.com/dell/ansible-unity/pulls) between your branch and the upstream master branch.
+6. Once your pull request has merged, your branch can be deleted.

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,137 @@
+<!--
+Copyright (c) 2022 Dell Inc., or its subsidiaries. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+-->
+
+# Code of conduct - contributor covenant
+
+## Our pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at ansible.team@dell.com
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary ban
+
+**Community impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent ban
+
+**Community impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

docs/COMMITER_GUIDE.md

@@ -0,0 +1,49 @@
+<!--
+Copyright (c) 2022 Dell Inc., or its subsidiaries. All Rights Reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+-->
+
+# Committer guidelines
+
+These are the guidelines for people with commit privileges on the GitHub repository. Committers act as members of the Core Team and not necessarily employees of Dell.
+
+These guidelines apply to everyone and as Committers you have been given access to commit changes because you exhibit good judgment and have demonstrated your commitment to the vision of the project. We trust that you will use these privileges wisely and not abuse it.
+
+If these privileges are abused in any way and the quality of the project is compromised, our trust will be diminished and you may be asked to not commit or lose these privileges all together.
+
+## General rules
+
+### Don't
+
+* Break the build.
+* Commit directly.
+* Compromise backward compatibility.
+* Disrespect your Community Team members. Help them grow.
+* Think it is someone elses job to test your code. Write tests for all the code you produce.
+* Forget to keep thing simple.
+* Create technical debt. Fix-in-place and make it the highest priority above everything else.
+
+### Do
+
+* Keep it simple.
+* Good work, your best every time.
+* Keep the design of your software clean and maintainable.
+* Squash your commits, avoid merges.
+* Be active. Committers that are not active may have their permissions suspended.
+* Write tests for all your deliverables.
+* Automate everything.
+* Maintain a high code coverage.
+* Keep an open communication with other Committers.
+* Ask questions.
+* Document your contributions and remember to keep it simple.
+
+## People
+
+| Name  |  GitHub ID  |  Nickname  |
+|-------|-------------|------------|
+|       |             |            |