From 084d252809ebccb4c00b9b802a90f68ee906a155 Mon Sep 17 00:00:00 2001 From: Ghanshyam Mann Date: Thu, 13 May 2021 18:12:01 -0500 Subject: [PATCH] [ussuri][goal] Update contributor documentation This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38521 Change-Id: I7f2fc02c036d71d76e1b6f69879641fef3271207 --- CONTRIBUTING.rst | 23 ++++++------ doc/source/contributor/contributing.rst | 47 +++++++++++++++++++++++++ doc/source/index.rst | 10 ++++++ 3 files changed, 70 insertions(+), 10 deletions(-) create mode 100644 doc/source/contributor/contributing.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 248eab92..7c50a3d6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,19 @@ -If you would like to contribute to the development of OpenStack, -you must follow the steps in this page: +The source repository for this project can be found at: - http://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/ec2-api -Once those steps have been completed, changes to OpenStack -should be submitted for review via the Gerrit tool, following -the workflow documented at: +Pull requests submitted through GitHub are not monitored. - http://docs.openstack.org/infra/manual/developers.html#development-workflow +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: -Pull requests submitted through GitHub will be ignored. + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html -Bugs should be filed on Launchpad, not GitHub: +Bugs should be filed on Launchpad: - https://bugs.launchpad.net/ec2-api \ No newline at end of file + https://bugs.launchpad.net/ec2-api + +For more specific information about contributing to this repository, see the +ec2-api contributor guide: + + https://docs.openstack.org/ec2-api/latest/contributor/contributing.html diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 00000000..baa51a48 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,47 @@ +============================ +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 ec2-api. + +Communication +~~~~~~~~~~~~~ +* IRC channel #openstack-ec2api at FreeNode +* Mailing list (prefix subjects with ``[ec2-api]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `ec2-api Core Team +`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +ec2-api features are tracked on `Launchpad `_. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Launchpad `_. +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 `_. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the ec2-api project require one +2 votes +from ec2-api core reviewers with approving patch by giving +``Workflow +1`` vote. + +Project Team Lead Duties +~~~~~~~~~~~~~~~~~~~~~~~~ +All common PTL duties are enumerated in the `PTL guide +`_. diff --git a/doc/source/index.rst b/doc/source/index.rst index c4e6d5a6..e106f8f8 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -52,6 +52,16 @@ EC2API Reference hacking +For Contributors +================ + +* If you are a new contributor to ec2-api please refer: :doc:`contributor/contributing` + + .. toctree:: + :hidden: + + contributor/contributing + Indices and tables ==================