No subject
Sun Mar 31 09:34:23 UTC 2013
=A0- what coding standards you have, or other expectations of the code<br>
(test coverage? comments? namespace management?)<br>
=A0- what is the practical workflow for review? [add comments to github<br>
pull requests?]<br>
=A0- how do I signal when I do/don't have time to contribute? [maybe th=
is<br>
works if it's just "review a pull request when you have time"=
]<br>
<br>
Perhaps a (very short) "how to be a reviewer" document would be u=
seful.<br></blockquote><div><br></div><div style>The web site doesn't a=
ppear to have a link to Github, but the stuff to be reviewed seems to be he=
re:</div>
<div style><a href=3D"https://github.com/openspending/openspending/pulls">h=
ttps://github.com/openspending/openspending/pulls</a><br></div><div style><=
br></div><div style>I couldn't find any documentation of the process or=
standards in the wiki or source tree.</div>
<div style><br></div><div style>Even simple things like standard terminolog=
y are helpful. =A0The first one I looked at to get a feel for how things wo=
rked had a comment of "This is a no-brainer." which is apparently=
a sign of approval because it got merged. I'd suggest +1 or Google'=
;s LGTM or some other standard approval phrase that's unambiguous.</div=
>
<div style><br></div><div style>In addition to Dan's (very good) questi=
ons, I'd add:</div><div style><br></div><div style>- What factors deter=
mine when a change is high enough risk to require depolyment to the staging=
server?</div>
<div><br></div><div style>Tom=A0</div><blockquote class=3D"gmail_quote" sty=
le=3D"margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(=
204,204,204);border-left-style:solid;padding-left:1ex">
<br>
best,<br>
Dan<br>
<div><div class=3D"h5"><br>
On 05/06/13 12:31, Tryggvi Bj=F6rgvinsson wrote:<br>
> Hi all,<br>
><br>
> OpenSpending is a platform that a lot of users (other sites) rely on s=
o<br>
> we care deeply about quality assurance. One of the things we do as par=
t<br>
> of QA is code review. A developer should never merge his/her changes<b=
r>
> into master unless somebody else has looked over the changes and given=
<br>
> them a "go".<br>
><br>
> For bigger changes we can also deploy the changes to our staging serve=
r<br>
> so code reviewers can test them on a live site as well.<br>
><br>
> Now, this makes the contribution process a bit longer. You contribute,=
<br>
> then you wait, then somebody reviews when that developer has time and<=
br>
> your changes (hopefully) get committed. If you need to make some more<=
br>
> changes you have to go back in line after you commit them.<br>
><br>
> Therefore we need many code reviewers to keep the process fast. We do<=
br>
> not make any requirements of technical knowledge about OpenSpending bu=
t<br>
> the code reviewer should be proficient in both Python and Javascript<b=
r>
> (and web development in general). The job of the code reviewer is just=
<br>
> to ask a lot of questions if there's any doubt as to why things ar=
e<br>
> implemented in a certain way.<br>
><br>
> So I want to make a proposal. Let's do "collaborative QA"=
;, we do code<br>
> review exchange. Who on this list are willing to become a code reviewe=
rs<br>
> for OpenSpending? In return I will become a code reviewer for their<br=
>
> projects.<br>
><br>
> --<br>
><br>
> Tryggvi Bj=F6rgvinsson<br>
><br>
> Technical Lead, OpenSpending<br>
><br>
</div></div>> The Open Knowledge Foundation <<a href=3D"http://okfn.o=
rg" target=3D"_blank">http://okfn.org</a>><br>
><br>
> /Empowering through Open Knowledge/<br>
><br>
> <a href=3D"http://okfn.org/" target=3D"_blank">http://okfn.org/</a> | =
@okfn <<a href=3D"http://twitter.com/OKFN" target=3D"_blank">http://twit=
ter.com/OKFN</a>> | OKF on Facebook<br>
> <<a href=3D"https://facebook.com/OKFNetwork" target=3D"_blank">http=
s://facebook.com/OKFNetwork</a>> | Blog <<a href=3D"http://blog.okfn.=
org/" target=3D"_blank">http://blog.okfn.org/</a>> |<br>
> Newsletter <<a href=3D"http://okfn.org/about/newsletter" target=3D"=
_blank">http://okfn.org/about/newsletter</a>><br>
><br>
><br>
><br>
> _______________________________________________<br>
> okfn-labs mailing list<br>
> <a href=3D"mailto:okfn-labs at lists.okfn.org">okfn-labs at lists.okfn.org</=
a><br>
> <a href=3D"http://lists.okfn.org/mailman/listinfo/okfn-labs" target=3D=
"_blank">http://lists.okfn.org/mailman/listinfo/okfn-labs</a><br>
> Unsubscribe: <a href=3D"http://lists.okfn.org/mailman/options/okfn-lab=
s" target=3D"_blank">http://lists.okfn.org/mailman/options/okfn-labs</a><br=
>
><br>
<br>
<br>
--<br>
Dan O'Huiginn<br>
Organised Crime and Corruption Reporting Project<br>
<br>
<a href=3D"mailto:daniel at ohuiginn.net">daniel at ohuiginn.net</a><br>
<a href=3D"http://ohuiginn.net" target=3D"_blank">http://ohuiginn.net</a> @=
danohu<br>
<a href=3D"http://reportingproject.net" target=3D"_blank">http://reportingp=
roject.net</a><br>
<br>
_______________________________________________<br>
okfn-labs mailing list<br>
<a href=3D"mailto:okfn-labs at lists.okfn.org">okfn-labs at lists.okfn.org</a><br=
>
<a href=3D"http://lists.okfn.org/mailman/listinfo/okfn-labs" target=3D"_bla=
nk">http://lists.okfn.org/mailman/listinfo/okfn-labs</a><br>
Unsubscribe: <a href=3D"http://lists.okfn.org/mailman/options/okfn-labs" ta=
rget=3D"_blank">http://lists.okfn.org/mailman/options/okfn-labs</a><br>
</blockquote></div><br></div></div>
--089e013c6200c110f304de68b758--
More information about the okfn-labs
mailing list