You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Include build instructions in README so contributors can (easily) get a local Jekyll setup going #79
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:
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).
Activity
peterjc commentedon 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 commentedon May 20, 2016
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 commentedon May 20, 2016
Yes please.
LalitNM commentedon Nov 23, 2020
In my opinion something simple like
CONTRIBUTING.rstshould work here. An example is here.Advantages of doing this:
peterjc commentedon Nov 23, 2020
Yes, but the content needs to be written...
LalitNM commentedon Nov 25, 2020
Sure. I will do that.