How to Contribute
python-tempestconf source code is publicly available. You can contribute code to individual projects, documentation, report bugs and vulnerabilities and request features.
Important information to mention:
- System on which the problem occurred (e.g. CentOS, Ubuntu, ...)
- The source of
python-tempestconfyou have used. The package version number in case of RPM or the branch used in case of installation from git.
- The exact command with all arguments you have used.
- It's always better to include the console output as well.
Create a story with a task for our project containing all the relevant information, mainly:
- description of the feature
- inputs (new CLI option, ...) and outputs (desired configuration in tempest.conf) of the feature
- the reason why it should be implemented
- If you have found a bug and you know how to fix it, please, check our storyboard project for any stories which may relate to the issue. If you haven't found any related stories, please, create one. Check Reporting Bugs.
- Follow Contributing Code and submit a code review in https://review.opendev.org/.
Like any other project part of OpenStack, the development of
python-tempestconf follows the OpenStack guidelines for contribution.
If you have made any changes in the source code, run tests locally before posting a review. You can do so by running tox.
If you've made any changes in the documentation (under
$ tox -edocs
If you've made any changes in the source code run unit tests as follows:
$ tox -epy36
and pep8 check like following:
$ tox -epep8
If you've written also a releasenote, make sure the syntax is correct by running:
$ tox -ereleasenotes
If you've made any changes which are related to a task in a story in our storyboard project, please, include a story and task number in the commit message.