Poblish readme file (#15)

CHANGELOG.md

@@ -2,9 +2,11 @@
 
 ## head
 
-## v0.0.2
+## v0.0.2 (2019-11-15)
+
 - Remove deprecated content
 - fix galaxy.yml
 
-## v0.0.1
-- Init release
+## v0.0.1 (2019-11-05)
+
+- Init release

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue, or any other method with the owners of this repository before making a change.
+
+## Pull Request Process
+
+1. Fork this project into your account if you are a first-time contributor.
+1. Create a branch based on the latest `dev` branch, commit your changes on this branch.
+1. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Release Process
+
+1. Create a release branch from the target commit on dev branch.
+1. Update version in [galaxy.yml](galaxy.yml) and release logs in [CHANGELOG.md](CHANGELOG.md).
+1. Make sure the release branch is ready to release, merge the release branch into master branch.
+1. Tag the master branch with new version number like `v*.*.*`, push to origin.
+1. Release pipleline will automatically release the new version to galaxy.
+1. Merge released changes back to `dev` branch.
+
+## Release status
+
+For each release details, you can refer to the [CHANGELOG](CHANGELOG.md) which contains the dates and significant changes in each minor release.

README.md

@@ -1,5 +1,9 @@
 # Ansible collection for Azure
 
+[![Doc](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://docs.ansible.com/ansible/latest/modules/list_of_cloud_modules.html#azure)
+[![Code of conduct](https://img.shields.io/badge/code%20of%20conduct-Ansible-silver.svg)](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html)
+[![License](https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg)](LICENSE)
+
 This collection provides a series of Ansible modules and plugins for interacting with the [Azure](https://azure.microsoft.com).
 
 ## Requirements
@@ -8,12 +12,22 @@ This collection provides a series of Ansible modules and plugins for interacting
 
 ## Installation
 
-```
+To install Azure collection hosted in Galaxy:
+
+```bash
 ansible-galaxy collection install azure.azcollection
 ```
 
+To upgrade to the latest version of Azure collection:
+
+```bash
+ansible-galaxy collection install azure.azcollection --force
+```
+
 ## Usage
 
+### Playbooks
+
 To use a module from Azure collection, please reference the full namespace, collection name, and modules name that you want to use:
 
 ```yaml
@@ -42,6 +56,10 @@ Or you can add full namepsace and collecton name in the `collections` element:
         account_type: Standard_LRS
 ```
 
+### Roles
+
+For existing Ansible roles, please also reference the full namespace, collection name, and modules name which used in tasks instead of just modules name.
+
 ## Resource Supported
 
 - azure_rm_deployment - Create or destroy Azure Resource Manager template deployments
@@ -62,3 +80,18 @@ Or you can add full namepsace and collecton name in the `collections` element:
 - azure_rm_virtualmachine_facts - Get virtual machine facts
 - azure_rm_virtualnetwork - Manage Azure virtual networks
 - azure_rm_virtualnetwork_facts - Get virtual network facts
+
+## Contributing
+
+There are many ways in which you can participate in the project, for example:
+
+- Submit bugs and feature requests, and help us verify as they are checked in
+- Review source code changes
+- Review the documentation and make pull requests for anything from typos to new content
+- If you are interested in fixing issues and contributing directly to the code base, please see the [CONTRIBUTING](CONTRIBUTING.md) document
+
+## License
+
+GNU General Public License v3.0
+
+See [LICENSE](LICENSE) to see the full text.