garris / garris/BackstopJS

Prerequisites missing

Open
#1,619 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
7.2k
Forks
621
PR merge metrics
No merged PRs in 30d

Description

Hi there, thanks for a great tool!

Not everyone here is a frontend developer, not everyone is on Mac etc. What is obvious to you is not clear to some of us at all! :-(

My suggestion is to add a Prerequisites section to the main page.

As an example, you could borrow something from [here](https://github.com/KulaginAnton/Backstop-Remote/blob/master/README.MD):

**Prerequisites**
- Nodejs 8.9.1 or higher
- Npm 5.5.1 or higher
- Chrome 62 or greater is required

Thanks again and stay healthy!

Contributor guide

Open the contributing guide

Research direction

Start with the project's main page and compare its current setup guidance with the linked example. Identify the supported Node.js, npm, and Chrome prerequisites, add a clearly labeled Prerequisites section, and verify that the documented requirements match the project.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.