Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/metsanpeitto/to-do-list_peer-review


https://github.com/metsanpeitto/to-do-list_peer-review

Last synced: 2 days ago
JSON representation

Awesome Lists containing this project

README

        

# Does my coding partner follow JS best practices?

![Microverse](https://img.shields.io/badge/Microverse-blueviolet)

![Alt text](screenshot.png?raw=true 'Screenshot')

## Learning objectives

- Give feedback on someone else's project based on clean code best practices.
Apply knowledge the student has gained in the past when giving a code review.
Perform a simple code review for a coding partner.
Understand existing code in a way that allows the student to give a good code review.

### Preparation
Create a new empty repo.
Copy your code from the "To Do list" project and commit it as one big chunk of code in a feature branch.
Open a pull request.
Ask you partner for a review in GitHub.
Share the pull request link with your partner.
Instructions:
Once you get a pull request link from your partner, go ahead and review it:
Reminder: How to give a code review.
Check the quality of the code (you can use previous lessons as a guide).
Remember to check for the following:
JavaScript best practices.
DRY, KISS, and YAGNI rules.
HTML & CSS best practices.
Finish your review with a nice summary.
Compare your review with the issue created by the project's author in the Do I follow JavaScript best practices? exercise.
There is no need to add anything to your review at this point. It is just to check if you both noticed the same issues.
Check the review you received from your partner!
You will make improvements to your code based on your partner's review in the next exercise.

=======

## Built With

- HTML/CSS
- Node.JS

=======

## Getting Started

If you want a copy of this file go to the github repository and download it from there

- [`git clone https://github.com/Metsanpeitto/to-do-list_peer-review`](https://github.com/Metsanpeitto/to-do-list_peer-review)

### Live

[Live](https://metsanpeitto.github.io/to-do-list_peer-review/)

### Setup

```cmd
git clone https://github.com/Metsanpeitto/to-do-list_peer-review.git
cd ./to-do-list_peer-review
```

#### If you are non a technical person you can download the zip file.

- To do that you have to go to the green button that says 'Code' and then press on it.
- Choose the option 'Download Zip' and wait until it download.
- Then you need to decompress it.
- You will need to have Zip compress file software installed in your computer. If you don't have it you can download it from here
[`https://www.7-zip.org/download.html`](https://www.7-zip.org/download.html)
- Do double click on the Capstone-1.zip and choose a folder where to place all teh decompressed files.
- Once you are done decompressing, you can open the created folder.
- In it you can double click on the index.html file and choose a browser to open it (For example google Chrome Browser).
- Now you should be able to see the project.
- Remember to use the mouse to navigate through the website. Also you can use the keys 'arrow up' and 'arrow down' of your keyboard
to scroll up and down.

### Prerequisites

- Node.JS

=======

## Author

👤 **Abraham Rodriguez**

- GitHub: [@metsanpeitto](https://github.com/Metsanpeitto)
- Twitter: [@metsanpeitto](https://twitter.com/home)
- LinkedIn: [Abraham Rodriguez](https://www.linkedin.com/in/abraham-rodriguez-3283a319a/)
- Portfolio: [Waldenberg](https://portfolio.waldenberginc.com)

=======

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

=======

## Show your support

Give a ⭐️ if you like this project!

=======

## Acknowledgments

- Microverse for giving me this chance
- The amazing code reviewers for making me improve every day :thumbsup:

=======