Include build instructions in README so contributors can (easily) get a local Jekyll setup going

Open
#79 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
Half a day
Newbie friendliness
42/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
jekyll
Domain
documentation

Research direction

Start with the repository README and the existing Jekyll setup used by the site. Document the steps contributors need to run the site locally and verify that the instructions are sufficient for testing website changes.

Written by the indexing model from the issue text.

Description

help wanted

I can work on this as I am trying to contribute to this repo and need a local Jekyll setup to test my changes anyways ..

Dominant language
CSS
Stars
167
Forks
379
No merged PRs in 30d

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.

More from biopython/biopython.github.io

All issues in biopython/biopython.github.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.