GitHub

From MozillaWiki
(Redirected from Github)
Jump to: navigation, search

This page is specifically about the "mozilla" organization on github. There are several other github organizations you may be interested in, cf. the incomplete list below.

Send us an email! Got a question?
Email github-owners At-teken.png mozilla.org

Bugzilla mozilla.org :: Github: Administration
irc #github on moznet

News

Recommendations and FAQ

Where should I ask additional questions?

  • Send an email to github-owners At-teken.png mozilla.org and we'll respond right away! We're also available on #github on irc.

How do I hook up a new 3rd party application to a repository in the mozilla org?

Note: There are now multiple 3rd pary application types. "GitHub Apps" (nee integrations) are the new approach and preferred.
Note: Some 3rd party apps use GitHub as an OAuth identity provider for their website (e.g. for a dashboard). An OAuth Application will block the installation process if the app is not already approved. The "Request access" block is what this section describes.

Each type has it's own installation and approval process. Please follow the instructions in the correct section below.

GitHub Apps Installation & Approval Process

GitHub Apps (formerly called "integrations") are "Installed" into either the entire organization, or into individual repositories. Each integration has a documented and granular access to repository resources. This is good.

However, the GitHub App installation can only be done by an organization owner, who may have to do additional housekeeping. This is not so good, so please plan accordingly (you may need to coordinate with GitHub owners).

  • File a request using this bug template
  • Include answers to these questions:
    • Which repositories do you want to have access? (all or list)
    • Do any of those repositories contain "sensitive" data? (e.g. private repos or ones where unauthorized code changes could have significant impact to Mozilla)
    • Provide link to vendor's description of permissions needed and why
    • Provide installation instructions:
      • Please include the GitHub App's "install" link
Initial Installation

If this is the first time this GitHub App is being installed in the organization, a few extra checks and coordination are needed. An organization owner will need to perform these steps:

  • Determine if the GitHub App previously had an OAUTH version.
    • If so, it is likely that installing the integration will disable all repositories in the organization using the OAUTH version of the application.
    • Find all current repositories using the classic OAUTH application (this is non-trivial, scripts exist to help)
    • Install the Integration for all current repositories, and the new one (organization owner permissions needed.)

Please do not install GitHub apps with organization wide scope without first discussing with GitHub owners.

Additional Installations or Removals

If the GitHub App has already been installed in the organization, the new repository simply needs to be added or removed from the list. An organization owner has to make this change. Please still file a bug.

If you're an org owner, you can see what has already been installed.

OAUTH (classic) Applications

  • Authorizing an application to work with GitHub utilizes the permissions your account has -- so, any repositories you have access to the application will have access to as well (including private ones). If you want to grant access to an application that no one else has used with the Mozilla organization yet you'll see a "Request access" button during the set up flow. You'll need to click that button to request approval. See below for an example:

Github approval.png

  • In some cases, the application does not need to be "approved" to function correctly, as it has read only access to any public repository. (Some applications only want write access to help you configure the application first time.)
  • In other cases, the application does need write permission, and/or permission to read a private repository. In these cases, open a bug using this template.
    • Please be sure to have clicked the "Request Approval" link before submitting bug.
  • Include answers to these questions:
    • Provide link to vendor's description of permissions needed and why
    • Provide installation instructions (both may be needed):

Reviewing owners and permissions

As an owner or repository admin you're responsible for maintaining the list of people with access to your projects. Please be active and prudent about maintaining this list.

Can I be an Owner of the Mozilla Organization?

The Owners group on GitHub has complete administrative power and will be limited to a minimal number of people and reviewed regularly. If a person is an owner, they are expected to actively participate in the group and assist others as requested. Owners will be added as a need arises (for example, support in another timezone) as determined by the current owners.

Can I be a Member of the Mozilla Organization?

Contributor Information

Good news! You do not need to be a member of the Mozilla organization on GitHub before you can contribute to Mozilla!!!! We have several sites which can help you find the best fit for contribution:

Once you're working on a project, the project leaders can help you get access to anything you need.

Team Maintainers & Project Leads

Project owners and team maintainers may find the following information helpful when asking for access for a new team member:

  • We prefer the use of github teams.
  • All members of the Mozilla organization on github agree to be bound by Mozilla's Commit Access Requirements, and should follow the intent of the Mozilla's Commit Access Policy as much as practical.
    • "Outside Collaborator": repository admins can grant outside collaborator to any GitHub account. "Outside Collaborator" is roughly analogous to "Level 1a" access to Mozilla-hosted repositories.
    • "Team Member": team maintainers can add GitHub users to a team, if they are already a member of the organization. If you are not yet a member of the organization, the team maintainer should file a bug using this link to add you to their team, as a form of vouching. "Team Member" is roughly analogous to "Level 2" or "Level 3", with the distinction being the content of the repositories managed by the team.

To get access for a new Contributor, please file a bug using this link, and fill in the details.

Please Note:

  • We will cancel any invitation to the organization which is not accepted within 2 weeks.
  • All members of the Mozilla organization on GitHub MUST have 2FA enabled.
  • Automation accounts are also required to have 2FA enabled. Scripts should use access tokens with minimum permissions to accomplish the task.

Should I make a separate github organization or just create a repository in an existing one?

This is a personal preference, in general. (Some product lines may have policies about source code locations.) If you have a large enough project or organization feel free. We suggest you use the strategies and recommendations here as a model to manage the details. Additional resources on establishing an organization are:

Forking vs Transferring

Do not "fork" a repository into a Mozilla organization. Doing so gives every team in the org rights to it.

If you have created a repo on your own account (for example, myuser/myrepo) and it should live under the Mozilla organization, here are the steps:

  1. If you're not a member of any team, talk to an org admin.
  2. Under the repo admin, transfer ownership to the Mozilla organization. If you don't see this option, return to step 1.
  3. Choose which teams should be given access. All chosen teams will have only 'read' access at this point.
  4. File a bug to grant admin permissions to a team or yourself.
    Note: As soon as you transfer, your repository will be in "limbo" (only you will have write access) due to a GitHub bug. Make arrangements in advance to have an owner available to process the bug.
  5. Fork the repo from Mozilla (mozilla/myrepo) back to your account (recreating myuser/myrepo). While the transferred repo becomes the root of the network on GitHub (e.g. all forks are now forks of mozilla/myrepo) other users may be pointing to your repo by URL. (Optional, github will redirect old URLs for transfers, but you probably want a local repo if you use the PR workflow.)

Do I need to be an owner to create repositories?

Not in the 'mozilla' organization. If you are a member, you can create a repository. Other organizations may restrict repository creation. However, it's preferred that you create repositories in the context of a team. Teams are created here, if necessary. Once you have created a repo, you can configure it to give rights to members of particular teams.

We have sensitive code or data in this repository - any extra steps I should take?

Yes. Even if your repository is private, there are steps you can take to ensure you know if something has changed. See the GitHub/Repository Security page for additional information and a checklist.

We're done with this project - what should we do with the repository?

That is really up to the team. However, if you have forks or other active user participation, it's a good idea to be clear about the status of Mozilla's commitment to the project. Your options include:

PLEASE make sure the repository is clearly licensed before leaving it. Without a license, many other folks can not build upon your work.

Are there requirements for when or how I should create a new team?

No. When requirements were proposed they all seemed too rigid and time consuming. Instead we recommend staying flexible and using good naming and documentation for projects (similar to naming CSS classes or variables).

On large teams we recommend you separate teams for read/write and repository administration.

Is "mozilla" the only github "organization" related to Mozilla?

No, there are plenty of Mozilla-related "organizations" on github. As a rule of thumb, initiatives that create a large number of sub-repositories will create their own "organization". Here is a (probably incomplete) list of them:

Organization Description Contact Owner
mozilla-it Mozilla IT's repositories  ?
mozillabrasil Mozilla Brazil  ?
bugzilla Bugzilla (the product, not bugzilla.mozilla.org) #bugzilla
drumbeat-badge-sprint Drumbeat Badge Lab  ?
hackasaurus Hackasaurus  ?
jetpack-labs Jetpack Labs  ?
mdn Mozilla Developer Network John Whitlock
mozbrick Mozilla Brick (web components library)  ?
mozilla-appmaker Mozilla Appmaker  ?
mozilla-b2g Mozilla Boot2Gecko / Firefox OS  ?
mozilla-bteam Bugzilla.Mozilla.org #bteam
mozilla-cit Mozilla Community Ops Tanner Filip (tanner) or Yousef Alam (yalam96)
mozilla-comm Calendaring and Messaging related projects  ?
mozilla-cordova Firefox OS Support for Apache Cordova  ?
mozilla-iam Mozilla's identity and access management kang
mozilla-platform-ops Mozilla Platform Operations Platform_Operations
mozilla-metrics Mozilla Metrics  ?
mozilla-raptor Mozilla Raptor / Firefox OS Performance Eli Perelman (eliperelman), Rob Wood (rwood)
mozilla-releng Mozilla Release Engineering #releng
mozilla-services Mozilla Services mozilla-services owners
mozilla-mobile Mobile: Android Product Team & Firefox iOS teams mozilla-mobile owners
mozilla-standards Mozilla Standards (for IPR Contributions) dbaron, annevk
mozilla-svcops Mozilla Cloud Services Ops Daniel Thornton (relud)
Mozilla-TWQA Mozilla Taiwan QA  ?
mozillahispano Mozilla Hispano  ?
MozillaScience Mozilla Science Lab  ?
MozillaSecurity Mozilla Platform Fuzzing Team master repo with many fuzzing tools under it.  ?
MozillaWiki MozillaWiki (wiki.mozilla.org) Christie Koehler (ckoehler), Gordon P. Hemsley (gphemsley)
mozillayvr Mozilla Vancouver @MozillaYVR Brian Clark (bclark), Stephanie Hobson (shobson)
mozfr Mozilla Francophone Pascal Chevrel https://mozillians.org/fr/u/pascalc/
opennews Knight-Mozilla OpenNews  ?
rust-lang The Rust Programming Language Aaron Turon (aturon)
servo Servo (browser engine written in Rust) Lars Bergstrom (larsberg), Jack Moffitt
tabulapdf Tabula project (extract data from PDF files)  ?
webcompat Web Compatibility Team Mike Taylor (miketaylr)
mozilla-l10n Mozilla l10n-drivers team Pascal Chevrel https://mozillians.org/fr/u/pascalc/
taskcluster TaskCluster Team Greg Arndt
MozillaCH Mozilla Switzerland Michael Kohler (mkohler), freaktechnik (freaktechnik)
MozMEAO Mozilla Marketing Benjamin Sternthal (bensternthal), Paul McLanahan (pmac)
mozilla-payments Implementation of Web Payment APIs Caceres Marcos Caceres
mozilla-jetpack Resources for Mozilla's Add-on SDK  ?
web-ext-experiments WebExtension API Experiments Andy McKay (andym)
mozilla-conduit Mozilla Conduit work Mark Côté (mcote)
mozsearch The code that runs Searchfox.org Kartikaya Gupta (kats)
MozillaCZ Mozilla.cz Michal Stanke (mstanke), Michal Vašíček (MekliCZ), Tomáš Zelina (zelitomas)
MozillaSK Mozilla.sk Michal Stanke (mstanke), Juraj Cigáň (kusavica)

Are there other unofficial or Mozilla-related repositories hosted on Github?

Why, yes! In no particular order: