(Redirected from QA:Taskotron contribution guide)
The repositories for the various components of Taskotron can be found on Pagure:
The repositories for the tasks developed alongside Taskotron itself are prefixed with task-.
Feel free to submit bugs or pull requests for any of these repositories. Pull requests in Pagure work much as they do in github, which you may well be familiar with: you can use the web interface to 'fork' the main project into your user namespace, then push changes to your fork (it's best to use one git branch per change) and use the web interface to submit pull requests from branches in your fork.
Remember, if you want to help out but are having trouble following these instructions, you can always get in touch with us for help! Please mail qa-devel or ask in #fedora-qa[?] and someone will likely be able to help you out.
There are some specific considerations for contributing to Taskotron components.
For most Taskotron components, we recommend you submit diffs from within a virtualenv. This will ensure the tests and linter (see below) run correctly. If run directly from the host system, they may not do so. The general process for creating and entering a virtualenv is as follows:
dnf install python2-virtualenv python-pip virtualenv --system-site-packages env_somename/ source env_somename/bin/activate
env_somename is an arbitrary name for the virtualenv; it's customary to name it for the project, but you can call it anything. To exit the virtualenv, run deactivate. Usually, after entering the environment, this will install the requirements for testing (and, if appropriate, running a development instance of) the project, and install the project within the virtualenv in 'editable' mode so that changes you make to the source will be immediately reflected when running the code in the virtualenv:
pip install --ignore-installed -r requirements.txt pip install -e .
Each project's own README file should usually contain more detailed instructions on this step for the specific project, so check that out too.
Gitflow is a git branching strategy that has been used successfully in the blocker tracking app and several Fedora infra apps. Most Taskotron component projects use the gitflow strategy.
# fork the project and clone it git checkout develop git pull git checkout -b feature/fixurl # do your work git commit git push # submit a pull request from web UI
Always remember to do a git pull to get all the latest changes.
Tests and linting
Taskotron components usually have test suites built on Pytest, and run lint checks using flake8. To ensure you have these packages installed, run sudo dnf install pytest python2-flake8 python-pep8. When testing and submitting changes, remember to run pytest inside your virtualenv to ensure the tests run correctly. Run flake8 and pep8 on files you modified to check for other errors (TODO: add better instructions).
General Thoughts and conventions
- Be smart
- All code going into develop branches MUST be reviewed
- All code should have good unit tests where appropriate
- When in doubt, ask