From 161c6d5a5d0b2473c9c45ea14f83614c8113dd5f Mon Sep 17 00:00:00 2001 From: Nicolas Bock Date: Mon, 13 Apr 2020 06:17:49 -0600 Subject: Community Goal: Project PTL & Contrib Docs Update This patch standardizes the CONTRIBUTING.rst file and adds information from the required doc/source/contributor/contributing.rst. Change-Id: I4a47ef22c70c6f6b225ea779227627d7f3078f4e Story: #2007236 Task: #38520 Signed-off-by: Nicolas Bock --- CONTRIBUTING.rst | 21 ++++++++++--------- doc/source/contributor/getting-involved.rst | 31 ++++++++++++++++++++++++++++- 2 files changed, 42 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 2157948b..95556c11 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: - https://docs.openstack.org/infra/manual/developers.html + https://opendev.org/openstack/designate -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. - https://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/designate + +For more specific information about contributing to this repository, see the +designate contributor guide: + + https://docs.openstack.org/designate/latest/contributor/getting-involved.html#contributing diff --git a/doc/source/contributor/getting-involved.rst b/doc/source/contributor/getting-involved.rst index 8e3d8ced..73332e13 100644 --- a/doc/source/contributor/getting-involved.rst +++ b/doc/source/contributor/getting-involved.rst @@ -9,12 +9,14 @@ Getting Involved #openstack-dns -------------- + There is an active IRC channel at irc://freenode.net/#openstack-dns, where many of the designate contributors can be found, as well as users from various organisations. Weekly meetings --------------- + There is a weekly irc meet. The agenda and other details are listed at `Designate meetings wiki page`_. Currently the meeting is held every Wednesday at 17:00 UTC on the IRC channel @@ -22,12 +24,38 @@ irc://freenode.net/#openstack-meeting-alt Contributing ------------ + +For general information on contributing to OpenStack please see 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. + We welcome fixes, extensions, documentation, pretty much anything that helps improve Designate, contributing is easy & follows the standard OpenStack `Gerrit workflow`_, if you're looking for something to do, you could always checkout the blueprint_ & bug_ lists. +Task Tracking +------------- + +We track our tasks in Launchpad + + https://bugs.launchpad.net/designate + +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 `_. + +Development Environment and Developer Workflow +---------------------------------------------- + Assuming you've already got a working :ref:`Development Environment`, here's a quick summary: @@ -53,6 +81,7 @@ Branch, work, & submit: Coding Standards ---------------- + Designate uses the OpenStack flake8 coding standards guidelines. These are stricter than pep8, and are run by gerrit on every commit. @@ -158,7 +187,7 @@ Example: ~~~~~~~~~~~~~~~~~~~ Akamai backend. Create and delete zones on Akamai. Blah Blah... - `Specs: Keystone Session `_ + `Specs: Keystone Session `_ `User documentation `_ -- cgit v1.2.1