nprapps / nprapps/nprapps.github.com

Document bootstrapping the project for local preview

Open Beginner friendly
#68 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
76
Forks
17
PR merge metrics
No merged PRs in 30d

Description

The README doesn't say how to install Jekyll (or that it assumes you have Ruby to install it).

Update the README and include a Gemfile to install Jekyll following the example in the GitHub Pages docs.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README and the linked GitHub Pages documentation for the local Jekyll setup. Add the project’s Gemfile and update the README to explain the Ruby prerequisite and Jekyll installation; done means a contributor can follow it to preview the site locally.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.