3c88e82871
- Add a top level CONTRIBUTING.rst for repo browsers - Refactor existing contributor guide - Add a contributor/contributing.rst file with links back to relevant manila documentation. - Rearrange some things in the main doc index file to make things prettier. Change-Id: I68ea17a71c4ea1e7aac5bea1ec8b95344cb256b7 Story: #2007236 Task: #39553 Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2.7 KiB
So You Want to Contribute...
For general information on contributing to OpenStack, check out the contributor guide to get started. It covers all the basics that are common to all OpenStack projects: the accounts you need, the basics of interacting with our Gerrit review system, how we communicate as a community, etc.
This project contains a python SDK and command line clients to interact with the API exposed by Manila, the OpenStack Shared File Systems service. Refer to the Contributor guide for Manila for information regarding the team's task trackers, communicating with other project developers and contacting the core team.
Bugs
You found an issue and want to make sure we are aware of it? You can do so on Launchpad.
If you're looking to contribute, search for the low-hanging-fruit tag to see issues that are easier to get started with.
Project Structure
This project includes three distinct components:
- manilaclient SDK: python bindings for Manila API version V1 and version V2
- manilaclient shell: A command
line utility (
manila) - OpenStack client shell: A plugin to support the OpenStack Client Command Line Interface.
The version 2 of the API for Manila supports microversions. The manilaclient library is expected to handle these for complete backwards compatibility. All versions of the Manila API are currently supported, however, future releases of manilaclient may drop support for older versions of the API.
If you're working on the OpenStack Client command line interface plugin that exists in this project, do read the OpenStack Client Developer Documentation. This includes the Human Interface Guide and some design priciples including command structure and command specs that you will find helpful.