diff --git a/.zuul.yaml b/.zuul.yaml index a866ee3..d6e7781 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -81,6 +81,7 @@ - ^doc/.* - ^README.rst - ^validations_common/.* + - ^CONTRIBUTING.rst gate: jobs: - openstack-tox-linters diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 84da616..d059663 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,8 +1,19 @@ -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. +If you're interested in contributing to the validations-common project, +the following will help get you started: + + https://docs.openstack.org/infra/manual/developers.html + +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 + +Pull requests submitted through GitHub will be ignored. + +Validations are meant to verify functionality of tripleo systems. +Therefore a special care should be given to testing your code before submitting a review. The information below will cover the project specific information you'll need to get started with validation-framework. @@ -21,7 +32,14 @@ after all the necessary discussions and procedures have taken place. Documentation ============= -Documentation for the TripleO project can be found `here `_ +For description of provided validations, modules and tools please refer to the `upstream documentation `_. +Separate documentation is provided about the runtime, `validations-libs `_ + +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. Communication ============= diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 6e1f2b5..9a7327a 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1,5 +1,6 @@ -========================= -So You Want To Contribute -========================= +================================== +Contributing to validations-common +================================== + .. include:: ../../CONTRIBUTING.rst