Files
openstacksdk/CONTRIBUTING.rst
Stephen Finucane 61323654eb tests: Use binary mode to open files
A recent change to the CONTRIBUTING.rst file introduced unicode
characters, which requests does not handle correctly when the file is
open in text mode. requests 3.0 is removing support for opening files in
text mode so we kill two birds with one stone here by switching to
opening the file in binary mode. We also remove the unicode character (I
tested the fix separately), correct the project name in the document,
and use the raise from syntax to get better error handling in these
cases.

Change-Id: I47d65383233e23ec5edf1e6735c39c66eeafb804
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2025-08-01 14:34:00 +01:00

50 lines
1.5 KiB
ReStructuredText

.. _contributing:
============================
Contributing to openstacksdk
============================
If you're interested in contributing to the openstacksdk project,
the following will help get you started.
Developer Certificate of Origin
-------------------------------
.. index::
single: license; agreement
In order to contribute to the openstacksdk project, you need to adhere
to the `Developer Certificate of Origin`_. OpenStack utilizes the Developer
Certificate of Origin (DCO) as a lightweight means to confirm that you are
entitled to contribute the code you submit. This ensures that you are
providing your contributions under the project's license and that you have
the right to do so.
Please read `DeveloperWorkflow`_ before sending your first patch for review.
Pull requests submitted through GitHub will be ignored.
.. seealso::
* https://docs.openstack.org/contributors/common/dco.html
.. _Developer Certificate of Origin: https://developercertificate.org/
.. _DeveloperWorkflow: https://docs.openstack.org/infra/manual/developers.html#development-workflow
Project Hosting Details
-----------------------
Project Documentation
https://docs.openstack.org/openstacksdk/latest/
Bug tracker
https://bugs.launchpad.net/openstacksdk
Mailing list (prefix subjects with ``[sdk]`` for faster responses)
https://lists.openstack.org/mailman3/lists/openstack-discuss.lists.openstack.org/
Code Hosting
https://opendev.org/openstack/openstacksdk
Code Review
https://review.opendev.org/#/q/status:open+project:openstack/openstacksdk,n,z