diff options
| -rw-r--r-- | CONTRIBUTING.rst | 22 | ||||
| -rw-r--r-- | doc/source/contributor/contributing.rst | 48 | ||||
| -rw-r--r-- | doc/source/index.rst | 16 | ||||
| -rw-r--r-- | lower-constraints.txt | 11 | ||||
| -rw-r--r-- | requirements.txt | 4 |
5 files changed, 75 insertions, 26 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 53da699..f2fda38 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,16 +1,20 @@ -If you would like to contribute to the development of OpenStack, -you must follow the steps documented at: +The source repository for this project can be found at: - https://docs.openstack.org/infra/manual/developers.html#development-workflow + https://opendev.org/openstack/python-heatclient -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 Storyboard, not GitHub: +Bugs should be filed on Storyboard,: https://storyboard.openstack.org/#!/project/openstack/python-heatclient + +For more specific information about contributing to this repository, see the +python-heatclient contributor guide: + + https://docs.openstack.org/python-heatclient/latest/contributor/contributing.html + diff --git a/doc/source/contributor/contributing.rst b/doc/source/contributor/contributing.rst new file mode 100644 index 0000000..e3b6bb1 --- /dev/null +++ b/doc/source/contributor/contributing.rst @@ -0,0 +1,48 @@ +============================ +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 python-heatclient. + +Communication +~~~~~~~~~~~~~ +* IRC channel #heat at OFTC +* Mailing list (prefix subjects with ``[heat]`` for faster responses) + http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss + +Contacting the Core Team +~~~~~~~~~~~~~~~~~~~~~~~~ +Please refer the `python-heatclient Core Team +<https://review.opendev.org/admin/groups/b4b16f97f2b8416cb0111c0bec5df885bd779347,members>`_ contacts. + +New Feature Planning +~~~~~~~~~~~~~~~~~~~~ +python-heatclient features are tracked on `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_. +Please specify the reported story with `python-heatclient`. + +Task Tracking +~~~~~~~~~~~~~ +We track our tasks in `Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_. +Please specify the reported story with `python-heatclient`. + +Reporting a Bug +~~~~~~~~~~~~~~~ +You found an issue and want to make sure we are aware of it? You can do so on +`Storyboard <https://storyboard.openstack.org/#!/project/openstack/heat>`_. +Please specify the reported story with `python-heatclient`. + +Getting Your Patch Merged +~~~~~~~~~~~~~~~~~~~~~~~~~ +All changes proposed to the python-heatclient project require one or two +2 votes +from python-heatclient core reviewers before one of the core reviewers can approve +patch by giving ``Workflow +1`` vote. + +Project Team Lead Duties +~~~~~~~~~~~~~~~~~~~~~~~~ +All common PTL duties are enumerated in the `PTL guide +<https://docs.openstack.org/project-team-guide/ptl.html>`_. diff --git a/doc/source/index.rst b/doc/source/index.rst index bb610d0..44f3a33 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -108,14 +108,12 @@ Man Pages man/heat -============ -Contributing -============ +For Contributors +================ -Code is mirrored `on GitHub`_. Submit bugs to the python-heatclient project on -`Launchpad`_. Submit code to the openstack/python-heatclient project using -`Gerrit`_. +* If you are a new contributor to python-heatclient please refer: :doc:`contributor/contributing` -.. _on GitHub: https://github.com/openstack/python-heatclient -.. _Launchpad: https://launchpad.net/python-heatclient -.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow + .. toctree:: + :hidden: + + contributor/contributing diff --git a/lower-constraints.txt b/lower-constraints.txt index 93c563a..c6ff3bf 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -16,9 +16,8 @@ dulwich==0.15.0 extras==1.0.0 fasteners==0.7.0 fixtures==3.0.0 -flake8==2.5.5 +flake8==3.7.0 future==0.16.0 -hacking==0.12.0 idna==2.6 imagesize==0.7.1 iso8601==0.1.11 @@ -27,16 +26,16 @@ jmespath==0.9.0 jsonpatch==1.16 jsonpointer==1.13 jsonschema==2.6.0 -keystoneauth1==3.4.0 +keystoneauth1==3.8.0 linecache2==1.0.0 MarkupSafe==1.0 -mccabe==0.2.1 +mccabe==0.6.0 monotonic==0.6 msgpack-python==0.4.0 munch==2.1.0 netaddr==0.7.18 netifaces==0.10.4 -openstacksdk==0.11.2 +openstacksdk==0.15.0 os-client-config==1.28.0 os-service-types==1.2.0 os-testr==1.0.0 @@ -55,7 +54,7 @@ positional==1.2.1 prettytable==0.7.2 pyasn1==0.1.8 pycparser==2.18 -pyflakes==0.8.1 +pyflakes==2.1.0 Pygments==2.2.0 pyinotify==0.9.6 pyOpenSSL==17.1.0 diff --git a/requirements.txt b/requirements.txt index b5a0c75..3874e36 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,11 +7,11 @@ pbr!=2.1.0,>=2.0.0 # Apache-2.0 cliff!=2.9.0,>=2.8.0 # Apache-2.0 iso8601>=0.1.11 # MIT osc-lib>=1.14.0 # Apache-2.0 -PrettyTable<0.8,>=0.7.2 # BSD +PrettyTable>=0.7.2 # BSD oslo.i18n>=3.15.3 # Apache-2.0 oslo.serialization!=2.19.1,>=2.18.0 # Apache-2.0 oslo.utils>=3.33.0 # Apache-2.0 -keystoneauth1>=3.4.0 # Apache-2.0 +keystoneauth1>=3.8.0 # Apache-2.0 python-swiftclient>=3.2.0 # Apache-2.0 PyYAML>=3.13 # MIT requests>=2.14.2 # Apache-2.0 |