Git Product home page Git Product logo

ghm's People

Contributors

ghassanmas avatar hasansaad1 avatar mynahmarie avatar

Watchers

 avatar  avatar

ghm's Issues

Readability

Your code should be easy to read ๐Ÿ“– so its easy to understand for anyone coming to look at your code. Its good practice to decide on a way to write before starting and then stick with this throughout the project ๐Ÿ‘Œ to stop inconsistencies such as in your css where there is a variety of blank lines or no blank lines between classes. Sometimes there are blank lines inside the classes which also makes it hard to read.

Separation of concerns

When writing code it is good practice to separate your concerns as this makes your code more readable both for yourselves and others coming to look at your project. Separation of concerns is applicable in your project where you are using both classes and id's (here) for styling. It is common practice to use classes for CSS and id's for your Javascript ๐Ÿ

Nice README

AWESOME ๐ŸŽ‰

I really like that you've added a section about the updates and the technologies in use ๐Ÿ‘. You mention the user stories but it could be a good idea to include the ones mentioned here.

Github work flow

It takes a while to get used to working on github however its a fairly important concept so in general we follow these rules:

  • create issues for each feature
  • create a new branch for one feature ๐ŸŒณ
  • do some changes, add and then commit them using the commit message to relate to an issue (relates #1)
  • checkout to master branch and git pull
  • checkout to the branch you were working on and git merge master
  • if you have merge conflicts you should solve them now
  • git push and create your PR and assign your fellow team mates as reviewers
  • all team members should then review your code and either approve โœ… or request changes โŒ
  • the final team member to review can merge the PR ๐ŸŽ‰ and delete the branch ๐Ÿ—‘๏ธ
  • NEVER merge your own PR ๐Ÿšซ
  • if everything to do with the issue is complete you can then close the issue ๐Ÿ™Œ

By creating issues you know exactly what work you are doing and so do your teammates. It is also worth noting the title and description of your commits and PR should explain what work you have done. I should be able to come to your project and view a coherent story of PR to see how your project has developed over time.

missing closing html tag

the tag is missing in the raw code on github. However, I can see it in the code under the console. May be browser adds it automatically

Sensible naming

It's really good practice to have sensible names for variables, classes, ids etc. This will help you and others understand each part of your codebase better. There are two nav bars and the only difference is the ids navbar and navbar1. You probably know exactly what the difference is, and I could find out by going through the CSS but it would be easier for everyone if there was a descriptive title ๐Ÿ‘

Use of promises

I do not have a problem with you using promises however this is a fairly advanced concept and I would be interested to know if everyone on the team understands promises concept. It is really important for everyone on the team to understand everything so please go through form.js together this morning.

Long line length makes for less legible content

Blocks of text should be limited to a certain number of characters/words per line. People are used to reading books with a line length of about 45โ€“90 characters, so as line length becomes longer it starts to get harder to scan the content. See this link for some more info. If the below section of the site had a maximum width it would look a lot more professional / readable.

selection_105

Remove unwanted code

When writing code we all comment out sections of code as this is a really useful way to try out different things. However once you have decided on the code you want its good to delete ๐Ÿ—‘๏ธ the commented code otherwise your files can get messy and become hard to read. These are the only lines I could find so its only a minor point ๐Ÿ‘

Javascript disabled

One of the user stories for this week:

As a client with JavaScript disabled in their browser for security reasons
I would like to visit your site and get a similar experience to viewing your site on a modern browser with JavaScript enabled
so that I don't feel like I'm completely in the stone age.

When I disable Javascript the form doesn't submit. Is there another way you could do a form without using Javascript?

Link to the website?

For this project it's a really good idea to host the site using github pages and provide a link in the README so people can view your site.

Indentation

Good indentation is really important as it makes code more readable! You can use an atom package called atom-beautify and that will help you to avoid your code looking like this and this.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.