Skip to content

Update CONTRIBUTING.md Section 1.5.a #7642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
5 tasks
k-cardon opened this issue Oct 28, 2024 · 3 comments
Open
5 tasks

Update CONTRIBUTING.md Section 1.5.a #7642

k-cardon opened this issue Oct 28, 2024 · 3 comments
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Wiki role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less

Comments

@k-cardon
Copy link
Member

k-cardon commented Oct 28, 2024

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

Some devs running WSL Ubuntu have been blocked by permission errors when running docker-compose up. This issue updates the contributing guide so that anyone who encounters this problem can quickly resolve it.

Action Items

  • In your local IDE, navigate to CONTRIBUTING.md
  • UPDATED 4-20-25: Navigate to 1.5.a Docker installation troubleshooting and, at the end of that section, add:
If you are using Windows Subsystem for Linux (WSL) and finding a permission error when running `docker-compose up`, the issue might be caused by a version of Docker that relies on a buggy version of Go. In your terminal, run `docker version` to see which `Go version:` is listed. Any version less than `go1.20.0` has a problem and indicates that your Docker needs to be updated.
  • With CONTRIBUTING.md still open, make a note of the section 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

CONTRIBUTING.md
Getting started with writing and formatting on GitHub

@k-cardon k-cardon added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers Feature: Wiki Complexity: Small Take this type of issues after the successful merge of your second good first issue size: 0.5pt Can be done in 3 hours or less labels Oct 28, 2024
@k-cardon k-cardon added the ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization label Oct 28, 2024
@ExperimentsInHonesty ExperimentsInHonesty removed the ready for merge team needs a senior review either to do some re writing or to approve it for ready for prioritization label Oct 30, 2024
@aswutmaxcy aswutmaxcy self-assigned this Nov 7, 2024
@aswutmaxcy aswutmaxcy moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Nov 7, 2024
@HackforLABot HackforLABot moved this from In progress (actively working) to New Issue Approval in P: HfLA Website: Project Board Nov 7, 2024
@HackforLABot

This comment has been minimized.

@aswutmaxcy aswutmaxcy moved this from New Issue Approval to Prioritized backlog in P: HfLA Website: Project Board Nov 7, 2024
@mchait18 mchait18 self-assigned this Nov 13, 2024
@HackforLABot

This comment has been minimized.

@HackforLABot HackforLABot moved this from Prioritized backlog to New Issue Approval in P: HfLA Website: Project Board Nov 13, 2024
@t-will-gillis t-will-gillis added Status: Unassigned by Bot Previously-prioritized issues that bot places in "New Issue Approval" and removed Ready for Prioritization labels Feb 25, 2025
@t-will-gillis t-will-gillis moved this from New Issue Approval to Prioritized backlog in P: HfLA Website: Project Board Mar 25, 2025
@t-will-gillis t-will-gillis removed the Status: Unassigned by Bot Previously-prioritized issues that bot places in "New Issue Approval" label Mar 25, 2025
@jsnhn jsnhn self-assigned this Apr 1, 2025
@HackforLABot

This comment has been minimized.

@jsnhn jsnhn moved this from Prioritized backlog to In progress (actively working) in P: HfLA Website: Project Board Apr 1, 2025
@t-will-gillis t-will-gillis moved this from In progress (actively working) to Prioritized backlog in P: HfLA Website: Project Board Jun 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Complexity: Small Take this type of issues after the successful merge of your second good first issue Feature: Wiki role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 0.5pt Can be done in 3 hours or less
Projects
Status: Prioritized backlog
Development

Successfully merging a pull request may close this issue.

7 participants