User:Tflink/taskotron contribution guide

From FedoraProject

< User:Tflink(Difference between revisions)
Jump to: navigation, search
(Installing Arcanist)
m (typos)
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 [[https://bitbucket.org/fedoraqa fedoraqa team]].
+
For now, all taskotron related code is on bitbucket. You can 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 taksotron 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 =

Revision as of 14:28, 21 January 2014

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

Contents

Introduction

Getting the Code

For now, all taskotron related code is on bitbucket. You can 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.

Note.png
Use the develop branch
When using gitflow, the current in-development branch is develop, not master. Be careful not to start developing against an older branch

Arcanist

At the time of this writing, the only way to submit code reviews is to use phabricator's cli tool, arcanist.

Installing Arcanist

Important.png
Use the Provided Packages
Do not install arcanist using the upstream installation guide. This will install whatever code is in git and may not match the phabricator server we are using.

There are phabricator related packages available for Fedora in a siderepo and you'll need to enable this siderepo before installing arcanist:

sudo curl http://repos.fedorapeople.org/repos/tflink/phabricator/fedora-phabricator.repo -o /etc/yum.repos.d/fedora-phabricator.repo

After that, just run yum install arcanist to install arcanist.

Arcanist Setup

In order to communicate with the phabricator instance, arcanist needs to have a certificate associated with your phabricator user. The easiest way to configure this is to clone the libtaskotron repo and from the checkout, execute arc install-certificate

You will be prompted to visit a link for a generated certificate used for api calls. After visiting that link and logging into phabricator, you will see a string of characters in a text box. Copy those characters and paste them into the arc prompt.

Submitting a Code Review

In short, code reviews are submitted through arcanist to phabricator through the arc diff command. More detailed instructions are available in the arcanist user guide.


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