Skip to content
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

Pre-work Checklist: Developer: Don #3188

Closed
20 of 31 tasks
DonaldBrower opened this issue Jun 1, 2022 · 13 comments
Closed
20 of 31 tasks

Pre-work Checklist: Developer: Don #3188

DonaldBrower opened this issue Jun 1, 2022 · 13 comments
Assignees
Labels
2 weeks inactive An issue that has not been updated by an assignee for two weeks Complexity: Prework prework Feature: Onboarding/Contributing.md role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours

Comments

@DonaldBrower
Copy link
Member

DonaldBrower commented Jun 1, 2022

Prerequisite

We are looking forward to having you on our team. Please make sure to attend the general Hack for LA onboarding to get the process started https://meetup.com/hackforla/events

Overview

As a new developer on the HfLA website team, fill in the following fields as you complete each onboarding item.

Action Items

  • Add yourself to the #hfla-site and #hfla-site-pr Slack channels
  • Share your GitHub handle and Gmail address with the team lead so you can be added to the Google Drive
  • Also, confirm with the team lead that they have added you to the Zoom meeting calendar invites
  • (Once added to the Drive) Add yourself to the team roster
  • After you have finished adding yourself to the roster, let a team lead know you have added yourself to the roster and would like to be added to the website-write and website teams on GitHub
  • Once added to the website-write team:
    • Self Assign this issue (gear in right side panel)
    • Add the "role: front end" or "role: back end" or both label(s) to this issue and remove the "role missing" label (gear in right side panel)
    • Add this issue to the Project Board under the Projects section (gear in right side panel)
  • Signup for a Figma account
  • Attend weekly team meetings:
    • Developer (front-end/back-end) weekly team meeting, Tuesdays 7-8pm PST
    • (Optional) Office Hours, Thursdays 7-8pm PST
    • All team meeting (UX, Development, Product), Sunday 10am-12pm PST
  • Note regarding weekly team meeting requirements: All website team members are required to attend at least 1 team meeting in a week (held on Tuesdays, Thursdays and Sundays). In case, you are unable in any given week, you should reach out to the tech leadership team. Exceptions to this requirement may be provided on a case-by-case basis. Also, please let the tech leadership team know (through a slack message in the hfla-site channel as well as an @ mention in a comment of the issue that you would be working on) if you are planning to take a week off or a longer vacation.
  • Complete steps 1.1 - 1.6 in Part 1: Setting up the development environment within Contributing.md
  • Read section 2.1 - 2.4 in Part 2: How the Website team works with GitHub issues within Contributing.md
  • Once you take a good first issue, you will provide estimates and progress reports. Also, once you finish providing your "Estimate" action item below, please answer the question in the "Time spent so far" action item (also below).
    • Estimate: Copy the below and put it in the "good first issue" that you picked.
      Check this box when you have completed this task so that we can identify if you understood the instructions and know what to do on all subsequent issues upon assignment.
    Availability for this week:
    My estimated ETA for completing this issue:
    
    • Time spent so far: Copy the question below into a new comment below and answer it. This is just to get feedback on how long it took you to get to this point on this pre-work. There is no right or wrong answers. There is no judgement. It is ok if you take a long time or if you do it really fast or at any pace.
    How many hours did it take you to finish the pre-work up to and including adding your initial ETA and availability for your good first issue, including attending your first meetings?
    
    • Progress Reports: Copy the below and put it in the issue once you have been assigned to the issue at least 5 days (we check weekly on Fridays), or sooner if you have something to report. If you finish this issue before 5 days are reached, Yeah!!, do it on your next issue. This update should be done every week for every issue. The checkbox here is meant for us to see if you understood the instructions when you end up doing your first weekly progress update.
    Provide Update
    1. Progress
    2. Blockers
    3. Availability
    4. ETA
    
  • Read sections 3.1.a - 3.1.c in 3.1 How to make a pull request to learn more about how to make a pull request (PR) for the issue that you are working on and how to make changes to your PR if changes are requested by the reviewer
  • Additional notes:
    • Please don't forget to review pull requests whenever you are able to. The How to review Pull Requests guide will teach you how to review pull requests.
    • Please work on only one issue at a time and wait until your pull request is merged before picking up another issue.
  • Read and understand how we progress through issues. Then, you can check this off.
    Progress through issues with increasing complexity in the following order:
    • Good first issue (one per person)
    • Good second issue (one per person)
    • Small (one per person, with some exceptions, see below)
    • Medium (you can work on more than one medium issue, but only one at a time)
    • Large (you can work on more than one large issue, but only one at a time)
      • The reasons for this progression are:
        • The issues start out as being prescriptive and become less so as you gain more experience by working through increasingly complex issues.
        • We are trying to teach you the team methodology through the issues themselves.
        • It ensures you understand what we expect and the quality of contributions.
      • You can work on back-to-back small issues if it meets the following criteria:
        • You are learning something new and need to work on an issue of a lesser complexity
        • Special request by a lead or pm
  • Go familiarize yourself with the Hack for LA Design System page in Figma (where you can see components and their SCSS classes)
  • Once all tasks are completed, close this issue. This issue will remain open until you get through your first progress report. Once you have done that, we are confident you know how to keep the momentum going on your issue and keep your team informed.

What should I do if I have a question about an issue I'm working on, and I haven't gotten a response yet?

  • First, you should post the question or blocker as a comment on your assigned issue, so it can be easily referred to in the next bullet points
  • Then, add the issue to the "Development team meeting discussion items" column of the Project Board so that it can be addressed in the next development meeting
  • You may also add the label "Status: Help Wanted" so other developers can see it and potentially help answer your question
  • Lastly, you can post your question in the hfla slack channel and link the issue you're working on, so other volunteers can see and respond

Resources/Instructions

@github-actions
Copy link

github-actions bot commented Jun 1, 2022

Hi @DonaldBrower.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing:
Role

NOTE: Please ignore the adding proper labels comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards.
To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Milestone" label once it is ready for prioritization.

Additional Resources:

@DonaldBrower DonaldBrower self-assigned this Jun 2, 2022
@DonaldBrower DonaldBrower added role: front end Tasks for front end developers role: back end/devOps Tasks for back-end developers and removed role missing labels Jun 2, 2022
@DonaldBrower
Copy link
Member Author

DonaldBrower commented Jun 4, 2022

I had a non-blocking issue while setting up the development environment:

  • Running docker-compose up fails with the following output. It fails because Ruby can't find the webrick package:
$  docker-compose up

Creating network "website_default" with the default driver
Pulling hfla_site (jekyll/jekyll:pages)...
pages: Pulling from jekyll/jekyll
df9b9388f04a: Pull complete
837e9cfc7e43: Pull complete
c7850f1a8c23: Pull complete
6ca4c39baa3d: Pull complete
daa3a8cb79d3: Pull complete
482896067e92: Pull complete
Digest: sha256:12400f663c4216295e4da3be29edd7eb9933dd697e0f663b167f538ad674e535
Status: Downloaded newer image for jekyll/jekyll:pages
Creating hfla_site ... done
Attaching to hfla_site
hfla_site    | ruby 3.1.1p18 (2022-02-18 revision 53f5fc4236) [x86_64-linux-musl]
hfla_site    | Configuration file: _config.yml
hfla_site    | Configuration file: _config.docker.yml
hfla_site    |             Source: .
hfla_site    |        Destination: /srv/jekyll/_site
hfla_site    |  Incremental build: enabled
hfla_site    |       Generating...
hfla_site    |                     done in 29.182 seconds.
hfla_site    |  Auto-regeneration: enabled for '.'
hfla_site    | <internal:/usr/local/lib/ruby/site_ruby/3.1.0/rubygems/core_ext/kernel_require.rb>:85:in `require': cannot load such file -- webrick (LoadError)
hfla_site    | ...
hfla_site exited with code 1
  • This issue from the jekyll project says that webrick isn't included in Ruby 3.x versions, and that it should be included manually.

  • For a work around, I made a copy of docker-compose.yml called docker-compose.local.yml, and included gem install webrick in the command for the hfla_site service. Here is the new file:

version: "3"
services:
  hfla_site:
    image: jekyll/jekyll:pages
    container_name: hfla_site
    command: >
      bash -c 
      "gem install webrick && jekyll serve --force_polling --livereload --config _config.yml,_config.docker.yml -I"
    environment:
      - JEKYLL_ENV=docker
    ports:
      - 4000:4000
      - 35729:35729
    volumes:
      - .:/srv/jekyll
  • docker-compose -f docker-compose.local.yml up to start the services with the new file.

I think anyone else setting up the environment for the first time, or otherwise pulling the latest jekyll:pages Docker image will have the same problem. This commit shows the authors updating to Ruby 3 on March 26

@Sparky-code
Copy link
Member

Sparky-code commented Jun 23, 2022

Hi @DonaldBrower Sorry for the slow reply

If you are having issues with Docker please see this thread on slack, it should solve the issue for now. We are working on a more permanent fix. A reminder to not use git add . when pushing changes to github as we do not want to push the altered docker-compose file.

Please move this issue to the In-Progress column on the Project Board.
Screen Shot 2022-06-23 at 3 15 54 PM

@github-actions github-actions bot added the 2 weeks inactive An issue that has not been updated by an assignee for two weeks label Jul 1, 2022
@github-actions
Copy link

github-actions bot commented Jul 1, 2022

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, June 28, 2022 at 12:21 AM PST.

@github-actions
Copy link

github-actions bot commented Jul 8, 2022

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, July 5, 2022 at 12:19 AM PST.

@github-actions
Copy link

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, July 12, 2022 at 12:20 AM PST.

@JessicaLucindaCheng JessicaLucindaCheng added this to the 08. Team workflow milestone Jul 16, 2022
@github-actions
Copy link

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, July 19, 2022 at 12:21 AM PST.

@ExperimentsInHonesty
Copy link
Member

@DonaldBrower we see you did two issues and then we didn't hear from you anymore. Are you still interested in working on the hfla website?

@github-actions
Copy link

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, July 26, 2022 at 12:20 AM PST.

@github-actions
Copy link

github-actions bot commented Aug 5, 2022

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 2, 2022 at 12:20 AM PST.

@github-actions
Copy link

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 9, 2022 at 12:20 AM PST.

@github-actions
Copy link

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 16, 2022 at 12:21 AM PST.

@github-actions
Copy link

@DonaldBrower

Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.

  1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
  2. Blockers: "Difficulties or errors encountered."
  3. Availability: "How much time will you have this week to work on this issue?"
  4. ETA: "When do you expect this issue to be completed?"
  5. Pictures (optional): "Add any pictures of the visual changes made to the site so far."

If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.

You are receiving this comment because your last comment was before Tuesday, August 23, 2022 at 12:25 AM PST.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 weeks inactive An issue that has not been updated by an assignee for two weeks Complexity: Prework prework Feature: Onboarding/Contributing.md role: back end/devOps Tasks for back-end developers role: front end Tasks for front end developers size: 1pt Can be done in 4-6 hours
Projects
Development

No branches or pull requests

5 participants