(initial contribution guide) |
m (this is how we bold!) |
||
(7 intermediate revisions by 6 users not shown) | |||
Line 4: | Line 4: | ||
= Getting the Code = | = Getting the Code = | ||
For now, all taskotron related code is on bitbucket. You can most of the needed repositories under the | For now, all taskotron related code is on bitbucket. You can find most of the needed repositories under the [https://bitbucket.org/fedoraqa fedoraqa team]. | ||
* [https://bitbucket.org/fedoraqa/libtaskotron libtaskotron] | * [https://bitbucket.org/fedoraqa/libtaskotron libtaskotron] | ||
* [https://bitbucket.org/fedoraqa/depcheck-mk-2 depcheck mk 2] | * [https://bitbucket.org/fedoraqa/depcheck-mk-2 depcheck mk 2] | ||
* [https://bitbucket.org/fedoraqa/taskotron-trigger | * [https://bitbucket.org/fedoraqa/taskotron-trigger taskotron trigger] | ||
* [https://bitbucket.org/fedoraqa/task-rpmlint task-rpmlint] | * [https://bitbucket.org/fedoraqa/task-rpmlint task-rpmlint] | ||
Line 17: | Line 17: | ||
If you need team membership, send a message out to qa-devel@ or file a ticket in phabricator against the infrastructure project. | If you need team membership, send a message out to qa-devel@ or file a ticket in phabricator against the infrastructure project. | ||
= Getting the Tools = | = Getting the Tools = | ||
Line 34: | Line 33: | ||
* [https://github.com/nvie/gitflow gitflow tool code and docs] | * [https://github.com/nvie/gitflow gitflow tool code and docs] | ||
{{admon/note|Use the develop branch|When using gitflow, the current in-development branch is <code>develop</code>, not <code>master</code>. Be careful not to start developing against an older branch}} | |||
== Arcanist == | == Arcanist == | ||
For instructions on installing and using the 'Arcanist' tool to submit changes for review, see [https://phab.qadevel.cloud.fedoraproject.org/w/contributing/ the Contributing page on the Phab wiki]. | |||
As we are using code linting, you will also need the flake8 tool - run {{code|sudo dnf install python-flake8}} to install it. | |||
= General Thoughts and Conventions = | = General Thoughts and Conventions = | ||
Line 64: | Line 45: | ||
These will be fleshed out more in the near future but in general: | These will be fleshed out more in the near future but in general: | ||
* Be smart | * Be smart | ||
* All code going into develop branches | * All code going into develop branches '''MUST''' be reviewed | ||
* All code should have good unit tests where appropriate | * All code should have good unit tests where appropriate | ||
** When in doubt, ask | ** When in doubt, ask |
Revision as of 07:05, 6 February 2016
This is an initial guide to getting started with contributing to taskotron, please let us know if you find any errors in this document or if something doesn't make sense
Introduction
Getting the Code
For now, all taskotron related code is on bitbucket. You can find most of the needed repositories under the fedoraqa team.
Other repos which are potentially of interest are:
If you need team membership, send a message out to qa-devel@ or file a ticket in phabricator against the infrastructure project.
Getting the Tools
A general list of the tools we are using (read: should be installed on dev machines) and available in the Fedora repos are:
- git
- py.test
- gitflow
gitflow
Gitflow is a git branching strategy that has been used successfully in the blocker tracking app and several Fedora infra apps.
Arcanist
For instructions on installing and using the 'Arcanist' tool to submit changes for review, see the Contributing page on the Phab wiki.
As we are using code linting, you will also need the flake8 tool - run sudo dnf install python-flake8 to install it.
General Thoughts and Conventions
These will be fleshed out more in the near future but in general:
- Be smart
- All code going into develop branches MUST be reviewed
- All code should have good unit tests where appropriate
- When in doubt, ask