tacker/CONTRIBUTING.rst
chenjiao f805cd7716 spelling error
Change-Id: I7a49e55549e770f0ceca74726580858fbffcdd45
2018-10-06 02:46:27 +00:00

71 lines
2.3 KiB
ReStructuredText

============
Contributing
============
The best way to join the community and get involved is to talk with others
online or at a meetup and offer contributions. Here are some of the many
ways you can contribute to the Tacker project:
* Development and Code Reviews
* Bug reporting/Bug fixes
* Wiki and Documentation
* Blueprints/Specifications
* Testing
* Deployment scripts
Before you start contributing take a look at the `Openstack Developers Guide`_.
.. _`Openstack Developers Guide`: https://docs.openstack.org/infra/manual/developers.html
Freenode IRC (Chat)
-------------------
You can find tacker guys in our publicly accessible channel on `freenode`_
``#tacker``. All conversations are logged and stored for your
convenience at `eavesdrop.openstack.org`_. For more information regarding
OpenStack IRC channels please visit the `OpenStack IRC Wiki`_.
.. _`freenode`: https://freenode.net
.. _`OpenStack IRC Wiki`: https://wiki.openstack.org/wiki/IRC
.. _`eavesdrop.openstack.org`: http://eavesdrop.openstack.org/irclogs/%23tacker/
Launchpad
---------
Like other OpenStack related projects, we utilize Launchpad for our bug
and release tracking.
* `Tacker Launchpad Project`_
.. _`Tacker Launchpad Project`: https://launchpad.net/tacker
.. note::
Bugs should be filed on Launchpad, not Github.
Source Repository
-----------------
The official Tacker source code is available in following repositories:
* **Tacker server:** https://git.openstack.org/cgit/openstack/tacker
* **Tacker Python client:** https://git.openstack.org/cgit/openstack/python-tackerclient
* **Tacker Horizon UI:** https://git.openstack.org/cgit/openstack/tacker-horizon
The mirror repositories on Github:
* **Tacker server:** https://github.com/openstack/tacker
* **Tacker Python client:** https://github.com/openstack/python-tackerclient
* **Tacker Horizon UI:** https://github.com/openstack/tacker-horizon
Gerrit
------
Like other OpenStack related projects, we utilize the OpenStack Gerrit
review system for all code reviews. If you're unfamiliar with using
the OpenStack Gerrit review system, please review the `Gerrit Workflow`_
wiki documentation.
.. _`Gerrit Workflow`: https://docs.openstack.org/infra/manual/developers.html#development-workflow
.. note::
Pull requests submitted through GitHub will be ignored.