From 52b216de3d1e7e29e69d8e3e326a4118978f5e61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Dulko?= Date: Thu, 23 Apr 2020 11:26:13 +0200 Subject: [PATCH] [ussuri][goal] Update contributor docs Change-Id: I094e4fcfc32cbcefdb96aa498f6c2c4ee3624019 --- CONTRIBUTING.rst | 30 ++++----- doc/source/contributing.rst | 5 -- doc/source/contributor/contributing.rst | 82 +++++++++++++++++++++++++ doc/source/contributor/index.rst | 8 +++ doc/source/index.rst | 2 +- 5 files changed, 104 insertions(+), 23 deletions(-) delete mode 100644 doc/source/contributing.rst create mode 100644 doc/source/contributor/contributing.rst create mode 100644 doc/source/contributor/index.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f863f307a..ffce2e746 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,23 +1,19 @@ -If you would like to contribute to the development of OpenStack, you must -follow the steps in this page: -https://docs.openstack.org/infra/manual/developers.html +The source repository for this project can be found at: -If you already have a good understanding of how the system works and your -OpenStack accounts are set up, you can skip to the development workflow section -of this documentation to learn how changes to OpenStack should be submitted for -review via the Gerrit tool: -https://docs.openstack.org/infra/manual/developers.html#development-workflow + https://opendev.org/openstack/kuryr-kubernetes -Pull requests submitted through GitHub will be ignored. +Pull requests submitted through GitHub are not monitored. -Bugs should be filed on Launchpad, not GitHub: -https://bugs.launchpad.net/kuryr-kubernetes +To start contributing to OpenStack, follow the steps in the contribution guide +to set up and use Gerrit: -If you want to have your code checked for pep8 automatically before committing -changes, you can just do:: + https://docs.openstack.org/contributors/code-and-documentation/quick-start.html - pip install pre-commit - pre-commit install +Bugs should be filed on Launchpad: -From that moment on, every time you run *git commit* it will first check your -diff for pep8 compliance and refuse to commit if it doesn't pass. + https://bugs.launchpad.net/kuryr-kubernetes + +For more specific information about contributing to this repository, see the +kuryr-kubernetes contributor guide: + + https://docs.openstack.org/kuryr-kubernetes/latest/contributor/contributing.html diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index 1f5ca23ce..000000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1,5 +0,0 @@ -============ -Contributing -============ - -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 000000000..b71700b45 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,82 @@ +============================ +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 kuryr-kubernetes. + + +Communication +------------- + +The primary communication channel of kuryr-kubernetes team is `#openstack-kuryr +channel on IRC `_. For more +formal inquiries you can use [kuryr] tag on `openstack-discuss mailing list +`_. +kuryr-kubernetes team is not holding weekly meetings, but we have office hours +every Monday at 15:00 UTC on our IRC channel. + + +Contacting the Core Team +------------------------ + +Outside of office hours, kuryr-kubernetes team is available mostly in the CET +working hours (7:00-17:00 UTC), as most of the team is located in Europe. Feel +free to try pinging dulek, ltomasbo, maysams or gryf on IRC, we have bouncers +set up so we'll answer once online. + + +New Feature Planning +-------------------- + +We don't really follow a very detailed way of feature planning. If you want to +implement a feature, come talk to us on IRC, create a `blueprint on Launchpad +`_ and start coding! +kuryr-kubernetes follows OpenStack release schedule pretty loosely as we're +more bound to Kubernetes release schedule. This means that we do not observe as +hard deadlines as other projects. + + +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 in either blueprints or bugs. + + +Reporting a Bug +--------------- + +You found an issue and want to make sure we are aware of it? You can do so on +`Launchpad `_. It won't hurt to +ping us about it on IRC too. + + +Getting Your Patch Merged +------------------------- + +We follow the normal procedures, requiring two +2's before approving the patch. +Due to limited number of contributors we do not require that those +2's are +from reviewers working for separate businesses. + +If your patch is stuck in review, please ping us on IRC as listed in sections +above. + + +Project Team Lead Duties +------------------------ + +All common PTL duties are enumerated in the `PTL guide +`_. + +And additional PTL duty is to maintain `kuryr images on Docker Hub +`_. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..c5a86cac1 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,8 @@ +=========================== + Contributor Documentation +=========================== + +.. toctree:: + :maxdepth: 2 + + contributing diff --git a/doc/source/index.rst b/doc/source/index.rst index 42a1b08a4..3ed05b2ba 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,7 +15,7 @@ Contents readme installation/index usage - contributing + contributor/index Developer Docs