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

Open
mgudapak opened this Issue May 19, 2016 · 3 comments

Projects

None yet

2 participants

@mgudapak
Contributor

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 ..

@peterjc
Member
peterjc commented May 19, 2016

Yes please - I'd mentioned a few bits of this on the mailing list, e.g.

I think people should fork the repository but should use their own account name for the repository name - i.e. username.github.io in order to get it rendered by GitHub, e.g. my username is peterjc:

https://github.com/peterjc/peterjc.github.io --> http://peterjc.github.io/

And then we'd need instructions on using Jekyll 3.0, see also https://github.com/biopython/biopython.github.io/blob/master/Gemfile

@mgudapak
Contributor

i am thinking they (a contributor) should be able to test it locally (as in run jekyll serve on their local machine) and test all pages/links rather than pushing it to their local repo (the fork) and then having GitHub render it under their account. The latter is another way but wouldn't you agree that ideally the contributor should be able to test it even before he pushes it to GitHub (albeit his local/forked repo).

@peterjc
Member
peterjc commented May 20, 2016

Yes please.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment