Skip to main content

[Team Leader] Working with GitHub Sandbox Repositories

In this article, you will learn everything you need to know on how to efficiently manage Sandbox GitHub repositories in DevChord projects.

Written by Evgeniya Graich

What is the DevChord GitHub Sandbox?

To support your squad project delivery, DevChord provides you with an option to use our sandbox repositories to manage the work in each of your sub-projects to have a dedicated space where your team can collaborate primarily when the client has not provided any access details (e.g. it is a proof-of-concept project or an MVP of a new product).

When to Opt for Sandbox GitHub Repositories in a Squad Project?

  • No Client Access: When client access isn't granted, typically during MVP or proof-of-concept phases.

  • Restricted Client Access: When you prefer to review work-in-progress pull requests before client visibility (less common).

How to Utilize Sandbox Repositories?

Option 1. The client hasn't provided any access:

  1. Create a new repository

  2. Add the client's remote or change the existing remote URL in your local folder

  3. Push the code in the new remote URL

To maintain Sandbox commit history confidentiality:

  1. Clone Client's Repository: Clone the client's repository into a new folder.

  2. Copy Sandbox Code: Copy the Sandbox code into the client's project folder, excluding the .git folder.

  3. Single Commit: Create a single commit containing all Sandbox changes.

  4. Push Code: Push the modified code to the client's repository.

Option 2. The client has provided you with a repository:

  1. Create a Patch Branch: Create a new branch in the client's repository.

  2. Transfer Code: Remove the existing code in the client's project folder, except the .git folder.

  3. Copy Sandbox Code: Paste the Sandbox code into the client's project folder, excluding the .git folder.

  4. Commit and Push: Commit and push the Sandbox code to the client's repository as a single commit.

  5. Pull Request: Create a pull request from the new branch to the desired branch in the client's repository.

This process is compatible with various Git-distributed version control systems such as GitHub, GitLab, Bitbucket, Heroku, and others.

Using the DevChord Interface.

To leverage Sandbox repositories via the DevChord interface:

  1. Select the "Use our sandbox" option from the banner on the squad project page.
    ​

  2. Upon selection, you'll be invited to join the DevChord GitHub organization. Provide your GitHub username if prompted.
    ​

  3. Ensure to accept the GitHub invitation. If not received, check spam folders or contact support.

  4. You'll gain "maintain" rights for all repositories within your squad sub-projects.

You can have a separate repository for each subproject or share the same repository for many subprojects. We from the DevChord side take care of managing engineers' invitations – once you approve an engineer for the subproject, they will be automatically invited to the corresponding team to have access to the repositories they need. Engineers will be provided with “read“ access only to repositories that belong to the subprojects they are working on.

Creating a Sandbox Repository:

  1. You will be able to create a sandbox repository directly from the DevChord interface once you start creating a sub-project. In fact, you should ONLY create new repositories from the DevChord interface so we can help you manage and maintain access.
    ​

  2. On the access step, you will have the option to either use the access data provided by the client, create a new sandbox repository, or use one of the already existing sandbox repositories (that was created for a previous sub-project). You have full flexibility on how many repositories you need.
    ​

  3. Engineers will be granted read access to Sandbox repositories upon assignment to sub-projects. To provide their work engineers will need to fork the repositories and create PRs into the original ones. No one except you will be able to push changes into the repositories. With “read” rights engineers will be able to review PRs of each other but only you’ll be able to merge the PRs.

Delivering Results to the Client:

Here is a summary of how you can share the final squad result with the client:

  • No Client Repository: Create a repository in the client's account and copy-paste the code.

  • Client Repository Exists (less common case): Copy the Sandbox implementation to the client's repository and create a pull request.

  • Sharing: Optionally, share a ZIP file containing the repository(ies) with the client. You can download the ZIP file directly from the DevChord interface.

Post-Project Management:

  • Upon project completion, engineer access to sub-project repositories will be revoked automatically.

  • In case you re-activate the sub-project by prolonging its deadline, the access will be returned automatically.

  • All repositories associated with a sub-project will be deleted upon project approval by the client.

Did this answer your question?