JiHu contribution process

Contributions from the JiHu team will follow two methods depending on whether they have JiHu proprietary changes or not.

  • Upstream method - start with a merge request in the GitLab Inc. repository.
  • Proprietary and upstream method - start with a merge request with all changes against the GitLab JiHu project and a merge request with all non-proprietary changes against the upstream project.

To identify contributions from JiHu, the ~"JiHu contribution" label is automatically applied to all upstream contributions coming from the JiHu team. To ensure the label is accurately applied, the gitlab-jh team must keep the direct members of gitlab-jh/jh-team updated with current team members.

JiHu enablement efficiency age and review metrics are publicly accessible in this dashboard.

The Engineering Productivity team is the DRI for JiHu Engineering enablement efficiency tooling and metrics.

Guidelines for upstream contributions

Contributions that do not involve JiHu proprietary content will be opened against the upstream project.

graph LR
  mr-->|Opened against upstream project|repo
  mr[/Upstream MR/]
  repo(GitLab Inc. Repo)

Upstream feature contribution guidelines

For large initiatives, ones that take multiple MRs or have broad-range implications, upstream feature contributions are more efficient and predictable when there’s joint upfront planning. In order to set up both teams for success they should follow these guidelines:

  1. At least one milestone prior to the milestone where implementation starts - JiHu team creates an upstream feature planning issue that provides an overview of the feature scope in English, intended uses, and iterative implementation plan. JiHu will ask the relevant team’s PM, Product Designer and EM for feedback on the issue and implementation plan.
    • The relevant GitLab product group will provide feedback on the feature, the relevant iterative implementation plan and provide feedback to JiHu.
  2. During implementation start - JiHu team will author MRs following the implementation plan and upstream guidelines below. The review will be done based on the agreement in the feature planing issue.

Example upstream planning issue: TBD

Guidelines for iterative contributions

Bigger product feature contributions should follow GitLab iteration strategies.

Iteration training is available to coach on GitLab’s value of iteration. This can be helpful to understand the expectations of GitLab product teams for feature iteration.

Not every features can follow the same strategy, but the first strategy we try should be crafting the minimal viable change, and for creating merge requests, always try to keep merge requests small.

In the above guidelines to keep merge requests small, we mentioned:

  • Horizontal slicing
  • Vertical slicing

Given JiHu upstream contributions cannot easily slice horizontally due to lacking developer permissions, always try to slice vertically first, that is, reduce the scope of the feature. Only consider slicing horizontally if it cannot be smaller, while it’s still too large to fit inside a single merge request.

Here are some examples for how we break down a feature in multiple iterations, both horizontally and vertically:

Feature Merge requests (not an exhaustive list) Slicing
GitLab Insights Mixture with both. Horizontally for the base and vertically on top of it
Filter search results by state Vertically that each merge request shipped a standalone feature

Guidelines for proprietary and upstream contributions

Contributions in projects that have proprietary and upstream contributions will use the following guidelines to have a streamlined review.

  1. The JiHu Engineering team will open two MRs:
    1. JiHu MR with all changes against the default branch in JiHu project.
    2. GitLab Inc MR with all non-jh/ changes against the default branch in GitLab Inc project.
  2. The GitLab Inc MR will be reviewed by the GitLab Inc team members. Reviewers should follow the guidelines for reviewing JiHu (JH) Edition related merge requests.
  3. After merging, the updates will be mirrored to JiHu project via pull mirroring and synchronized via code sync, merging into the default branch main-jh in the JiHu project.
  4. The JiHu Engineering team will remove all non-jh/ changes from the JiHu MR.
  5. The JiHu Engineering team will review and merge the JiHu MR in the JiHu project.
  6. A scheduled pipeline every 2 hours will run in compliance-verification against the JiHu project pulling mirror to verify that there are no code difference outside of jh/ directory beside agreed difference for package.json and yarn.lock.

Diagrem of the GitLab JiHu MR Process

JiHu contribution identification

Contributions from JiHu team members are labeled with JiHu contribution label via:

Merge request review process

  1. JiHu author submits upstream merge request in draft
  2. JiHu author’s manager is mentioned in the merge request description
  3. JiHu team will conduct a peer-review
  4. Once JiHu team peer review is complete. JiHu R&D manager or maintainer will add LGTM or Looks good comment in the MR.
  5. Merge request is then set to ‘ready’ state by JiHu team.
  6. JiHu author will request a review using @gitlab-bot request_review to identify and work on merging the MR with a merge request coach
  7. The MR goes through our documented review process which includes:
    1. Code review by domain experts
    2. Review from owners of specific code files. JiHu merge request author is responsible to mention team members from list of require approvals in the MR Approvals widget. Currently for the following area:
      1. Authentication related code
    3. GitLab Security Review, which will be triggered automatically.

What approvals are required

Upstream merge requests require the same level of review and approval as all merge requests including:

Upstream merge requests may require additional specific team reviews based on changed files. High impact code is identified with CODEOWNERS rules and required approvals for specific files. For example, if the merge request includes changes related to authentication or authorization, it must be approved by a Manage:Authentication and Authorization team member

What to review

  • Do not review changes inside jh/:
    • If the specific change is only needed for JiHu, it should go into jh/ directory in the JiHu project repository.
  • Changes outside of jh/ directory. Some examples include:

Merge request review escalation

Please refer to our guidelines.

Release certification process

The Application Security team performs a certification of each release that includes JiHu contributions. Please see this documentation for more information about this process.

Certification issues containing a report can be found in the issue tracker of the jh-upstream-report repository.