diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c4a044f339..9080417881 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -16,4 +16,4 @@ Bugs should be filed on Launchpad: For more specific information about contributing to this repository, see the openstack-ansible contributor guide: - https://docs.openstack.org/openstack-ansible/latest/contributor/contribute.html + https://docs.openstack.org/openstack-ansible/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000000..ff7fb82586 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,105 @@ +============================ +So You Want to Contribute... +============================ + +For general information on contributing to OpenStack, please 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. + +Below will cover the more project specific information you need to get started +with OpenStack-Ansible. + +Communication +~~~~~~~~~~~~~ + +IRC channel +^^^^^^^^^^^ + +The OpenStack-Ansible community communicates in the #openstack-ansible IRC +channel hosted on freenode. This channel is logged, and its logs are published +on http://eavesdrop.openstack.org/irclogs/%23openstack-ansible/. + +Weekly meetings are held in our IRC channel. The schedule and +logs can be found on +http://eavesdrop.openstack.org/#OpenStack_Ansible_Deployment_Meeting. +The agenda for the next meeting can be found on our +`Meetings wiki page `_. + +Mailing lists +^^^^^^^^^^^^^ + +Members of the OpenStack-Ansible community should monitor the +**OpenStack-discuss** `mailing lists`_. + +.. _mailing lists: http://lists.openstack.org/cgi-bin/mailman/listinfo + +All our communications should be prefixed with **[openstack-ansible]**. + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ + +All of our core team is available through IRC and present in #openstack-ansible +channel on Freenode. The list of the current members of the OpenStack-Ansible Team +might be found on `gerrit`_. + +.. _gerrit: https://review.opendev.org/#/admin/groups/490,members + + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ + +If you would like to contribute towards a role to introduce an OpenStack +or infrastructure service, or to improve an existing role, the +OpenStack-Ansible project would welcome that contribution and your assistance +in maintaining it. + +Please look through :dev_docs:`Contributor Guidelines ` +page for more information about the process. + + +Task Tracking +~~~~~~~~~~~~~ + +We track our tasks in Launchpad + + https://bugs.launchpad.net/openstack-ansible + + +If you're looking for some smaller, easier work item to pick up and get started +on, search for the 'low-hanging-fruit' tag. + + +Reporting a Bug +~~~~~~~~~~~~~~~ + +You found an issue and want to make sure we are aware of it? You can do so on +`Launchpad +`_. + + +Also you may find more detailed information about how to work with bugs +on the page :dev_docs:`Bug Handling ` + + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ + +Any new code will be reviewed before merging into our repositories and +requires at least 2 approvals from our Core team. + +We follow openstack guidelines for the `code reviewing `_ process. + +Please be aware that any patch can be refused by the community if they +don't match the :ref:`codeguidelines`. + + +Project Team Lead Duties +~~~~~~~~~~~~~~~~~~~~~~~~ + +All common PTL duties are enumerated in the `PTL guide +`_. + +All Core reviewer duties are described on the page +:dev_docs:`Core Reviewers `. diff --git a/doc/source/index.rst b/doc/source/index.rst index dbf021de5f..b259d1c523 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -21,6 +21,7 @@ OpenStack-Ansible Ussuri is currently in development. Release notes admin/index user/index + contributor/contributing contributor/index reference/index