Skip to content

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

Open

Description

@mgudapak

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

Activity

  1. peterjc commented on May 19, 2016

    @peterjc
    Member

    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

  2. mgudapak commented on May 20, 2016

    @mgudapak
    ContributorAuthor

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

  3. peterjc commented on May 20, 2016

    @peterjc
    Member

    Yes please.

  4. LalitNM commented on Nov 23, 2020

    @LalitNM
    Contributor

    In my opinion something simple like CONTRIBUTING.rst should work here. An example is here.

    Advantages of doing this:

    • GitHub will sync this file to every issue and pull request page.
    • In future if our readme grows, then it would be easy to separate that content in two files.
    • This is more common on GitHub.
  5. peterjc commented on Nov 23, 2020

    @peterjc
    Member

    Yes, but the content needs to be written...

  6. LalitNM commented on Nov 25, 2020

    @LalitNM
    Contributor

    Sure. I will do that.

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions