diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 01dd82f..b648a48 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1,3 +1,6 @@ +Contribution Overview +===================== + If you would like to contribute to the development of OpenStack, you must follow the steps in this page: @@ -15,3 +18,34 @@ Pull requests submitted through GitHub will be ignored. Bugs should be filed on StoryBoard, not GitHub: https://storyboard.openstack.org/#!/project/811 + +Developing bindep +================= + +Either install `bindep` and run ``bindep test`` to check you have the needed +tools, or review ``bindep.txt`` by hand. + +Running Tests +------------- + +The testing system is based on a combination of tox and testr. The canonical +approach to running tests is to simply run the command `tox`. This will +create virtual environments, populate them with dependencies and run all of +the tests that OpenStack CI systems run. Behind the scenes, tox is running +`testr run --parallel`, but is set up such that you can supply any additional +testr arguments that are needed to tox. For example, you can run: +`tox -- --analyze-isolation` to cause tox to tell testr to add +--analyze-isolation to its argument list. + +It is also possible to run the tests inside of a virtual environment +you have created, or it is possible that you have all of the dependencies +installed locally already. If you'd like to go this route, the requirements +are listed in requirements.txt and the requirements for testing are in +test-requirements.txt. Installing them via pip, for instance, is simply:: + + pip install -r requirements.txt -r test-requirements.txt + +In you go this route, you can interact with the testr command directly. +Running `testr run` will run the entire test suite. `testr run --parallel` +will run it in parallel (this is the default incantation tox uses.) More +information about testr can be found at: http://wiki.openstack.org/testr diff --git a/README.rst b/README.rst index 6872980..34bcc14 100644 --- a/README.rst +++ b/README.rst @@ -153,34 +153,3 @@ To select the curl package, the OpenStack CI default file uses:: This selects the ``curl`` package on all distributions with the exception of Gentoo, and selects ``net-misc/curl`` on Gentoo only. - -Developing bindep -================= - -Either install `bindep` and run ``bindep test`` to check you have the needed -tools, or review ``bindep.txt`` by hand. - -Running Tests -------------- - -The testing system is based on a combination of tox and testr. The canonical -approach to running tests is to simply run the command `tox`. This will -create virtual environments, populate them with dependencies and run all of -the tests that OpenStack CI systems run. Behind the scenes, tox is running -`testr run --parallel`, but is set up such that you can supply any additional -testr arguments that are needed to tox. For example, you can run: -`tox -- --analyze-isolation` to cause tox to tell testr to add ---analyze-isolation to its argument list. - -It is also possible to run the tests inside of a virtual environment -you have created, or it is possible that you have all of the dependencies -installed locally already. If you'd like to go this route, the requirements -are listed in requirements.txt and the requirements for testing are in -test-requirements.txt. Installing them via pip, for instance, is simply:: - - pip install -r requirements.txt -r test-requirements.txt - -In you go this route, you can interact with the testr command directly. -Running `testr run` will run the entire test suite. `testr run --parallel` -will run it in parallel (this is the default incantation tox uses.) More -information about testr can be found at: http://wiki.openstack.org/testr