Summary:

Add docs on developing against Review Board and maintaining forks

Review Request #1014 — Created Sept. 1, 2009 and submitted

Information
Owner:	chipx86
Repository:	Review Board
Branch:	master
Bugs:
Depends On:
Reviewers
Groups:	reviewboard
People:

Description

This is a new batch of docs that detail how to begin working on contributing to Review Board. It explains how to set up a development tree, the basics of branches, and contributing changes back.

There's also some docs in there for maintaining a fork of Review Board using GitHub or a custom solution.

Testing Done

Built the docs and read through them a bit.

docs/codebase/custom-forks.txt (Diff revision 1)

I don't think people need to create a server (that's only if they want to serve it to people), they just need a clone. It's perfectly valid to do a clone straight from the reviewboard public clone URL, commit some changes locally, then periodically fetch and merge/rebase to stay current with upstream. I'd argue that's maybe even the way most people maintaining a private fork for their organization would do it.

Also, our->your.

chipx86 Sept. 1, 2009, 3:50 p.m.

This isn't really about just maintaining a one-off developer checkout. This is about maintaining an actual fork of Review Board inside a company that other developers can access an contribute to.

david Sept. 1, 2009, 4:08 p.m.

Okay, in that case, can you make that clear? I think that in most cases for small teams, there will be a dude that maintains the reviewboard server and has their checkout with a couple small changes, and setting up a server for git collaboration isn't really appropriate for that.

docs/codebase/getting-started.txt (Diff revision 1)

Two comments here.

I'd change "You should also use a..." to "Some people find it helpful to use a..."

gitx -> gitk

Change Summary:

* Make it more clear why you'd use a custom fork in a centralized place.
* Fix a case where "gitx" was referenced instead of "gitk."
* Make it sound less like a requirement to use gitk/gitx.

Diff:

Revision 2 (+495)

Show changes

	docs/codebase/custom-forks.txt
	docs/codebase/getting-started.txt
	docs/codebase/index.txt

docs/codebase/custom-forks.txt (Diff revision 2)

Leftovers?

chipx86 Sept. 3, 2009, 7:02 p.m.

Fixed, and committing. I can make any additional changes if you spotted anything else.