Skip to content

Update CONTRIBUTING.md Docker Compose Syntax to V2 #8183

@ryanfkeller

Description

@ryanfkeller

Prerequisite

  1. Be a member of Hack for LA. (There are no fees to join.) If you have not joined yet, please follow the steps on our Getting Started page and attend an onboarding session.
  2. Before you claim or start working on an issue, please make sure you have read our How to Contribute to Hack for LA Guide.

Overview

The docker-compose command in CONTRIBUTING.md reflects Docker Compose V1, which is no longer included by default in recent Docker Desktop installations. As a result, new contributors may encounter errors when following the setup instructions. This issue updates references to this command in CONTRIBUTING.md to use the supported V2 syntax: docker compose (space instead of hyphen).

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md
  • Find and replace all instances of:
docker-compose

with

docker compose
  • There are 9 instances to update -- ensure all are replaced for consistency
  • With CONTRIBUTING.md still open, make a note of the sections in which the replaced content appears, so that you will know where to look in the document to preview the change.
  • Changes to CONTRIBUTING.md cannot be tested locally, rather they must be tested after pushing the issue branch to your fork of the repository. Push your issue branch in the usual manner, but before creating the Pull Request, check your updates using this test URL. Also store the test URL for use in a later step:
https://github.com/[REPLACE WITH GITHUB HANDLE]/website/blob/[REPLACE WITH NAME OF ISSUE BRANCH]/CONTRIBUTING.md

(for example: https://github.com/bonniewolfe/website/blob/issue-branch-1234/CONTRIBUTING.md)

  • Create a pull request with your changes. In the Pull Request, after the "Why did you make the changes" section, add this line to help reviewers, replacing the text in brackets (and the brackets) with the test URL from the previous Action Item.
For Reviewers: Do not review changes locally, rather, review changes at [REPLACE WITH TEST URL]

Resources/Instructions

Docker Compose V1 → V2 migration guide
CONTRIBUTING.md
Getting started with writing and formatting on GitHub

Metadata

Metadata

Assignees

Type

No type

Projects

Status

QA

Relationships

None yet

Development

No branches or pull requests

Issue actions