openinfra/python-tempestconf
Code Issues Proposed changes
master
python-tempestconf/doc/source/contributor/contributing.rst
Martin Kopec 444e826923 Fix doc style issues and fix some typos 
Removes yaml as a type of the code-block as the rendered
text was hardly readable.
Removes shell-session type of the code-block in case of showing
cat output - the output wasn't rendered at all.
Removes emphasize-lines as the emphasized lines were too bright
and therefore not readable - I found there are issues with
openstackdocstheme and Sphinx 3 [1] and I didn't find any simple
solutions - fixing just a few highlighted lines is not worth it.
A few typos were fixed as well.

[1] https://bugs.launchpad.net/openstack-doc-tools/+bug/1876343

Trying if rebuilding the doc solves the rendering issue:
https://docs.openstack.org/python-tempestconf/latest/user/usage.html

Change-Id: I83ebfdeb949bd0a6cfa99889cb9fbb56d8bcb218
2021-01-29 19:27:37 +00:00

2.6 KiB
Raw Permalink Blame History

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.

Reporting Bugs

We have a storyboard project created to track any change required for python-tempestconf. If you have found any bug, please, report it there.

Important information to mention:

  • System on which the problem occurred (e.g. CentOS, Ubuntu, ...)
  • The source of python-tempestconf you 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.

Requesting Features

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

Fixing bugs

  1. 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.
  2. Follow Contributing Code and submit a code review in https://review.opendev.org/.

Contributing Code

Like any other project part of OpenStack, the development of python-tempestconf follows the OpenStack guidelines for contribution.

Learn how to contribute into OpenStack.

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 doc/) run:

$ 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.