Skip to content

lab-antwerp-1/home

Repository files navigation

Lab Antwerp 1

Rubber Ducky

Rubber Ducky

This repository is yours to keep track of what you've covered so far, to get to know each other, to share helpful resources, to practice collaboration workflows, ... to do everything!

Slack is great for chatting but links and good explanations can easily get lost in message history. Think of this repository as your class' forum and home page.


Getting Started

expand/collapse
  1. git clone git@github.com:HackYourFutureBelgium/template-markdown.git
  2. cd template-markdown
  3. npm install

Code Quality Checks

  • npm run format: Makes sure all the code in this repository is well-formatted (looks good).
  • npm run lint:ls: Checks to make sure all folder and file names match the repository conventions.
  • npm run lint:md: Will lint all of the Markdown files in this repository.
  • npm run lint:css: Will lint all of the CSS files in this repository.
  • npm run validate:html: Validates all HTML files in your project.
  • npm run spell-check: Goes through all the files in this repository looking for words it doesn't recognize. Just because it says something is a mistake doesn't mean it is! It doesn't know every word in the world. You can add new correct words to the ./.cspell.json file so they won't cause an error.
  • npm run accessibility -- ./path/to/file.html: Runs an accessibility analysis on all HTML files in the given path and writes the report to /accessibility_report

Continuous Integration (CI)

When you open a PR to main/master in your repository, GitHub will automatically do a linting check on the code in this repository, you can see this in the./.github/workflows/lint.yml file.

If the linting fails, you will not be able to merge the PR. You can double check that your code will pass before pushing by running the code quality scripts locally.



Modules


TOP


Students


TOP


Coaches


TOP


Using this Repo

Here are 5 tips for using issues in this repository:

Help Wanted

  • The Template: If you're blocked on something in an assignment or self-study you can use the help-wanted template to create a new issue and ask for help.
  • The Label: You can attach the help-wanted label to any issue or PR that you need help completing. If the code you are blocked on is in another repository, you can create a new issue using the help-wanted template to describe your problem and link to your code.

Question

  • The Template Got a question about anything? Go ahead and ask! You can use create a new issue using the question template to ask your question in a clear and structured way.
  • The Label: Or add the question label to any other issue! This can help be helpful for searching check-ins or deliverables.

Check-Ins

template + label

Each module you will create a new check-in issue. You will use this issue to keep track of your self-study progress, and to post a check-in comment for each chapter including:

  • I need help with
  • What Went Well
  • What Went Less Well
  • Lessons Learned
  • Prep Work (for the next chapter)

Deliverable

template + label

For each project/exercise/assignment (individual or group) you will place a new issue on the Class Projects board.

  • If you are blocked, add the help-wanted label
  • When you think you're finished, move your issue into the Ready for Review column
    • If your assignment is complete, a coach will move it into the Done column
    • Else they will move it to Needs Revision. When you've addressed the feedback you can move it back into Ready for Review

Roll-Calls

Each Sunday before class your coach will create a new Roll Call issue. Leave a little comment to say hello and let us all know how your week went.