Browse Source

[ussuri][goal] Update contributor docs

Change-Id: I094e4fcfc32cbcefdb96aa498f6c2c4ee3624019
changes/40/722240/5 2.0.0.0rc1
Michał Dulko 1 year ago
parent
commit
52b216de3d
5 changed files with 104 additions and 23 deletions
  1. +13
    -17
      CONTRIBUTING.rst
  2. +0
    -5
      doc/source/contributing.rst
  3. +82
    -0
      doc/source/contributor/contributing.rst
  4. +8
    -0
      doc/source/contributor/index.rst
  5. +1
    -1
      doc/source/index.rst

+ 13
- 17
CONTRIBUTING.rst View File

@ -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

+ 0
- 5
doc/source/contributing.rst View File

@ -1,5 +0,0 @@
============
Contributing
============
.. include:: ../../CONTRIBUTING.rst

+ 82
- 0
doc/source/contributor/contributing.rst View File

@ -0,0 +1,82 @@
============================
So You Want to Contribute...
============================
For general information on contributing to OpenStack, please check out the
`contributor guide <https://docs.openstack.org/contributors/>`_ 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 <irc://irc.freenode.net:+6697/openstack-kuryr>`_. For more
formal inquiries you can use [kuryr] tag on `openstack-discuss mailing list
<http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss>`_.
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
<https://blueprints.launchpad.net/kuryr-kubernetes>`_ 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
<https://bugs.launchpad.net/kuryr-kubernetes>`_.
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 <https://bugs.launchpad.net/kuryr-kubernetes>`_. 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
<https://docs.openstack.org/project-team-guide/ptl.html>`_.
And additional PTL duty is to maintain `kuryr images on Docker Hub
<https://hub.docker.com/orgs/kuryr/repositories>`_.

+ 8
- 0
doc/source/contributor/index.rst View File

@ -0,0 +1,8 @@
===========================
Contributor Documentation
===========================
.. toctree::
:maxdepth: 2
contributing

+ 1
- 1
doc/source/index.rst View File

@ -15,7 +15,7 @@ Contents
readme
installation/index
usage
contributing
contributor/index
Developer Docs


Loading…
Cancel
Save