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

Style Guide Updates from Ass1 and Ass2 feedback #13

Merged
merged 28 commits into from
Oct 11, 2023

Conversation

GHWang28
Copy link
Contributor

@GHWang28 GHWang28 commented Oct 9, 2023

QoL/misc additions

  • Improved the example accordions - they are also by default closed now so it's easier to navigate through pages
    image
  • Added: "Below is our style guide for COMP6080 for writing X. For anything not mentioned here, refer to the Y."

Style Guide Changes

For HTML:

  1. Spamming line break tags and  
  2. No redundant attributes on tags
  3. Avoid having multiple separate versions of a webpage component
  4. Remove blocks of commented out code
  5. Reworked alt tag - new examples on how to write good alt tags and added exception to not needing alt tag for images used for decoration (like for bullet points).

For CSS:

  1. Overuse of !important
  2. Avoid negative margins
  3. Remove empty rulesets
  4. Remove blocks of commented out code

For Javascript:

  1. Reworked "Arrow functions over Regular functions" - removed the previous absolute need for arrow functions and added examples of when to use arrow functions and when to use regular functions.
  2. Remove blocks of commented out code

@chamhayden chamhayden merged commit 33e6ebd into chamhayden:master Oct 11, 2023
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants