Skip to content

Latest commit

 

History

History
152 lines (110 loc) · 9.02 KB

README.md

File metadata and controls

152 lines (110 loc) · 9.02 KB
Raw

DIME GitHub Account Guidelines

Git/GitHub trainings resources

This repo includes instructions related to DIME's GitHub account. For Git/GitHub trainings and DIME Analytics other Git/GitHub resources see here see here and/or here.

Actions for the DIME Account:

These instructions applies to repos with URLs starting with: https://github.com/dime-worldbank. Read more about why we use multiple accounts here.

Actions for the WB Account:

These instructions applies to repos with URLs starting with: https://github.com/worldbank. Read more about why we use multiple accounts here.

General GitHub Actions:

Other accounts

DIME Analytics can provide general advice for DIME repos hosted on other accounts. For example accounts owned by external collaborators the project work with. But since DIME Analytics do not have admin rights on those repos, there are no specific guidelines for such repos.

Why add DIME users as members first?

Users with an active contract with DIME ("DIME users") should be added as members of the https://github.com/dime-worldbank account ("DIME account members"). Adding DIME users as account members has these advantages:

  • Project teams can give and revoke access to their repos when DIME users join or leave the team without having to involve DIME Analytics
  • Collaboration across teams is easier as other DIME users can quickly be given access to repos without having to involve DIME Analytics
  • This provides a way to manage access to content on the DIME account to DIME members only.

DIME Account

These instructions applies to repos with URLs starting with: https://github.com/dime-worldbank.

DIME Account: Request membership

  • DIME users: eServices request (WB intranet access only - if you do not have access to the eServices portal someone else can make the request on your behalf)
  • WB non-DIME users: If you have an active WB contract and work on a portfolio of DIME projects you may still be added as a member. Discuss with your DIME contact and then submit the request for DIME users and list the DIME contact in the request when asked to.
  • External users: External users are only given access on per repo basis. See repo access section below.

Quick notes:

  • You must have a YubiKey or a WB computer to be able to access the WB account as a member. WB users without this can still be added as external users.
  • Joining the WB account do not by itself give access to any repo hosted there

See pages with instructions for more details.

See pages with instructions for more details.

DIME Account: Repo access

Quick notes:

  • Users who already are members of the DIME account (see above how to become a member) are given access to the repo by adding them to the GitHub team used for that repo.
  • The maintainer of the GitHub team can add DIME account members to the team without involving DIME Analytics. (DIME Analytics can help but will reach out to maintainer for approval.)
  • To see who is maintainer of a GitHub team, see the team reports. To see what GitHub team is used for a repo, see the repo reports.
  • External collaborators are not added to the DIME account and can therefore not be added to GitHub teams. Instead, external collaborators are added to individual repos.
  • The request to add external collaborators to a repo should be sent to DIME Analytics by a person at DIME.

See pages with instructions for more details.

DIME Account: Repo creation

Quick notes:

  • The request to create a new repo can be sent by anyone in DIME (does not need to be a member of the DIME account or even have a GitHub account)
  • The request to create a new repo needs to be approved by a DIME manager

See pages with instructions for more details.

WB Account

These instructions applies to repos with URLs starting with: https://github.com/worldbank.

WB Account: Request membership

  • WB users: eServices request (WB intranet access only - if you do not have access to the eServices portal someone else can make the request on your behalf)
  • External users: External users are only given access on per repo basis. See repo access section below.

Quick notes:

  • You must have a YubiKey or a WB computer to be able to access the WB account as a member. WB users without this can still be added as external users.
  • Anyone with an active WB contract and a GitHub account can use the eServices request to join the WB account
  • Joining the WB account do not by itself give access to any repo hosted there

See pages with instructions for more details.

WB Account: Repo access

Quick notes:

  • Similarly to the DIME account, WB account members are given access to repos through maintainers adding them to GitHub teams on the WB account.
  • GitHub teams on the DIME account cannot be used for repos on the WB account
  • DIME Analytics does not generate repo and team reports (i.e. these) for the WB account. Instead, browse this page https://github.com/orgs/worldbank/teams (WB account member access only) to find which team is used for which repo.
  • External collaborators are not added to the DIME account and can therefore not be added to GitHub teams. Instead, external collaborators are added to individual repos.
  • The request to add external collaborators to a repo should be sent to DIME Analytics by a person at DIME.

See pages with instructions for more details.

WB Account: Repo creation

Quick notes:

  • Most repos should be created on the DIME account, but reach out to DIME Analytics if you think your repo should be hosted on the WB account
  • The request to create a new repo can be sent by anyone in DIME (does not need to be a member of the DIME account or even have a GitHub account)
  • The request to create a new repo needs to be approved by a DIME manager

See pages with instructions for more details.