← Back to branch summary

~sinzui/ubuntu/wily/juju-core/wily-1.24.7

« back to all changes in this revision

Viewing changes to src/github.com/juju/juju/CONTRIBUTING.md

  • Committer: Package Import Robot
  • Author(s): Oleg Strikov
  • Date: 2015-03-26 15:54:39 UTC
  • mfrom: (1.1.32)
  • Revision ID: package-import@ubuntu.com-20150326155439-ot7bwwyoomq13btm
Tags: 1.22.0-0ubuntu1
https://launchpad.net/bugs/1416051
https://launchpad.net/bugs/1427879
https://launchpad.net/bugs/1434092
* New upstream release (LP: #1416051).
* d/patches/fix-detect-new-release.patch: Added upstream patch to redeem
  the ability to handle future Ubuntu releases (LP: #1427879, #1434092).
* d/tests/fake-future.sh: New ability to generate fake /etc/os-release.
* d/copyright: Updated to reflect changes in the codebase.
* d/control:
  - Change build dependency from gccgo to gccgo-go.
  - Use either cloud-image-utils or cloud-utils as dependency for juju-local
    because cloud-image-utils is not available on precise.
  - Compliance to Debian Policy 3.9.6 was declared.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/github.com/juju/juju/CONTRIBUTING.md
13
13
 
14
14
* issue tracker: https://launchpad.net/juju-core
15
15
* continuous integration: http://juju-ci.vapour.ws:8080/
 
16
* code review: http://reviews.vapour.ws/
16
17
 
17
18
Documentation:
18
19
* https://juju.ubuntu.com/docs/
62
63
 
63
64
For information on setting up and using git, check out the following:
64
65
 
65
 
* https://www.atlassian.com/git/tutorial/
 
66
* https://www.atlassian.com/git/tutorials/
66
67
* http://git-scm.com/book/en/Getting-Started-Git-Basics
67
68
* [Github bootcamp](https://help.github.com/categories/54/articles)
68
69
 
198
199
        "time"
199
200
 
200
201
        "labix.org/v2/mgo"
201
 
        gc "launchpad.net/gocheck"
202
202
        "github.com/juju/loggo"
 
203
        gc "gopkg.in/check.v1"
203
204
 
204
205
        "github.com/juju/juju/state"
205
206
        "github.com/juju/juju/worker"
207
208
 
208
209
```
209
210
 
210
 
Because "launchpad.net/gocheck" will be referenced frequently in test suites,
 
211
Because "gopkg.in/check.v1" will be referenced frequently in test suites,
211
212
its name gets a default short name of just "gc".
212
213
 
213
214
 
261
262
 
262
263
`juju` uses the `gocheck` testing framework. `gocheck` is automatically
263
264
installed as a dependency of `juju`. You can read more about `gocheck`
264
 
at http://go.pkgdoc.org/pkg/launchpad.net/gocheck. `gocheck` is integrated
 
265
at http://godoc.org/gopkg.in/check.v1. `gocheck` is integrated
265
266
into the source of each package so the standard `go test` command is used
266
267
to run `gocheck` tests. For example
267
268
 
353
354
Code review
354
355
-----------
355
356
 
356
 
A branch needs at least one approval review in order to land. By
357
 
convention, this is signaled by `LGTM` in a review comment. In the rare
358
 
case where a proposal has an issue that means it should not land,
359
 
`NOT LGTM` can be used as a veto. Often several rounds of suggestions are
360
 
made without either marker, and `LGTM` is added when the comments are
361
 
addressed.
362
 
 
363
 
After a proposal has received an `LGTM`, the landing must be notified to
364
 
test and merge the code into master. This is done by a member of the
365
 
juju project adding the magic string `$$merge$$` in a comment.
 
357
The juju project uses peer review of pull requests prior to merging to
 
358
facilitate improvements both in code quality and in design.  The code
 
359
review tool is ReviewBoard, hosted at http://reviews.vapour.ws/.  In the
 
360
event that the site is down, the project will temporarily fall back to
 
361
github for reviews of critical pull requests.
 
362
 
 
363
A review request is automatically created for every pull request.  A
 
364
link to that review request is added to the body of the pull request.
 
365
Whenever the pull request is updated, the review request is likewise
 
366
updated.  Thus for the normal workflow of contribution, there should
 
367
be no need to worry about creating or updating review requests.
 
368
 
 
369
Once you have created your pull request, it will be reviewed.  Make sure
 
370
to address the feedback.  Your request might go through several rounds
 
371
of feedback before the patch is approved or rejected.  Once you get a
 
372
"ship it" from a member of the juju project, and there are not any
 
373
"NOT LGTM" comments in ReviewBoard or github, you are ready to have your
 
374
patch merged by a member of the juju team.  Congratulations!
 
375
 
 
376
The code review site uses github OAuth for authentication.  To log in
 
377
simply go to login page and click the "github" button.  The first time
 
378
you do this, it will redirect you to github to approve access and then
 
379
redirect you back.  This first time is the only one where you will be
 
380
redirected to github.  Furthermore, ReviewBoard will keep you logged in
 
381
between visits via session cookies.
 
382
 
 
383
That first time you log in, a ReviewBoard account will be created for
 
384
you using your github username.  However, your email address is not
 
385
added.  If you want to receive review-related email, be sure to add your
 
386
email address to your ReviewBoard profile.
 
387
 
 
388
For more information on ReviewBoard see:
 
389
 
 
390
 doc/contributions/reviewboard.md
366
391
 
367
392
Continuous integration
368
393
----------------------