So you've signed up with RBCommons. Welcome! Let's get you set up so you can get back to your job. Your first experience is going to be different depending on whether you're an administrator for your team, or a user.
If you're a user and want to get started posting patches, read Posting Patches for Review.
Setting Up Your Team
Once you've created your team, you're going to need to set it up. There are three things you'll want to do:
- Link up your repositories (from your own server, or a service like GitHub)
- Create one or more review groups for your users (these are where review requests will be sent)
- Invite some users to your team
Let's step through that.
First, open your Team Admin page. You can reach this by clicking "Team Admin" on the right side of your team's navigation bar (the grey one) on any page.
We need to know a bit about your repositories before you can post any patches against them.
First, click "Repositories" on the left. Then click "Create a repository."
Here, we'll ask for some information on where your repository is. There are four sections. We'll go through them one-by-one.
Pretty simple here. Fill out the "Name" field with whatever you want to name this repository.
This is where you'll link up your GitHub, Bitbucket, etc. account for the repository, if you have one. If you're self-hosting, just leave this at its default and skip to the next section.
Select the hosting service where your repository lives. You'll get some new fields that will ask you to link an account.
In general, the account you link should be the account on the service that owns the repository. The exception is if you're using GitHub organizations, in which case it just has to be any account that's a member of your organization and has access to the repository.
If you've linked an account before, you can just select it in the list. Otherwise, choose "<Link a new account>" and fill in your username and, if needed, your password.
Don't worry! We're not going to save your password. We'll use it to get an authorization token from the service that will let us talk to it from here on out. You can always revoke access to RBCommons later if you need to.
The fields you have to feel out may vary depending on the type of repository and the hosting service you selected. Basically, this section tells us where the repository actually is.
First, select the type of repository. Some services offer more than one type.
If you're using a hosting service, and it offers different types of service plans (like GitHub's personal, private, personal organization, and private organization plans), select the one for the repository you want to add.
Then fill out the remaining fields. If you're using a hosting service, you'll need to give the repository name (exactly as it appears on the hosting service). If your repository is self-hosting, you'll need to provide the full path to the repository.
Setups can vary wildly, so don't hesitate to contact us if you have any questions here!
When you're filling out a review request, you can say which bugs were fixed or addressed. If you fill out the Bug Tracker section for your repository, we'll link any mentioned bugs directly to the bug reports.
If you're using your hosting service's bug tracker, just select "Use hosting service's bug tracker." See? Easy.
If you're using another bug tracker, select it from the list and provide the details.
Then just click "Create Repository," and you should be good to go! We'll let you know if there were any problems with the information you provided.
Create a .reviewboardrc file
We make use of .reviewboardrc files with our RBTools scripts (see Posting Patches for Review). This tells us our scripts where your RBCommons account is and which repository it should be working with. You'll want to place one of these in the root of every repository you have linked up.
On the Repositories list, clicking "RBTools Configuration" next to a repository will tell you exactly what you need to place in that file. Just commit it and you'll be set.
A review group is sort of like a category for review requests. You can create as many review groups as you need, and your users can join any they like (unless they're invite-only, which we'll get to in a sec). Review requests can be assigned to individual people, or to review groups.
First, click "Groups" on the left, and then click "Create a group."
Give the group a name. This is the ID of the group, and should be short without spaces. This is what people will type when assigning a review request. This could be something like "core-team."
Then give it a display name. Something like "The Awesome Core Team."
If you want any e-mails sent to this group to go to a mailing list, fill that in as well.
If you want the group to be hidden (maybe it's an old group?), uncheck "Visible."
If you need to separate who can see what, you can mark a group as Invite Only and then hand-pick the users who are part of that group. Only members of that group will be able to see the review requests assigned to that group (unless they're also assigned to standard group).
We find most people don't need this option, but it's there for the rest of you!
Then just click "Create Group," and you're good to go. Users can join this group from their "My Account" page.
Getting your team members up and running is as simple as typing their e-mail address.
Click "Users" on the left, type the e-mail address of a user to invite, and click "Add." They'll get an e-mail inviting them to RBCommons with a link to complete their registration. They'll then be added directly to your team.
If they already have an account on RBCommons, just type their username instead.
You can always remove a user by clicking "Remove."
If you have a user that you want to give administrator privileges to, just click the little pencil icon next to their name and mark them as an administrator right there.