search

swcarpentry / DEPRECATED-bc

DEPRECATED: This repository is now frozen - please see individual lesson repositories.
Other
299 stars 383 forks source link

Readme and contributing changes #543

Closed stevenkoenig closed 10 years ago

stevenkoenig commented 10 years ago

Greg asked volunteers to review these two files ([Discuss] volunteer wanted to clarify README.md and CONTRIBUTING.md) and I did. Feel free to comment.

After squashing (and accidentally squashing too much and splitting again) I put the stuff into a new branch. At least, rebuilding history with Git works well. First pull request was #537.

Feedback on how I should have done this instead are welcome ;D

codersquid commented 10 years ago

I'd like to verify all of the installation instructions while also reviewing content. Is there a jenkins job or something similar that does all of the installation steps then runs through rendering of pages?

If there isn't, then I'd be cautious about over-specifying how to install things. Usually I link out to a project's installation instructions because their install docs will be more up to date than mine. But, if there is an automated way to install all the requirements and build the site, then I am more okay with keeping the detailed installation instructions here since we'd know when they break.

ChristinaLK commented 10 years ago

Work also being done in https://github.com/swcarpentry/bc/pull/544 . Feel free to chip in!

gvwilson commented 10 years ago

We should merge #543 as soon as possible so that we can then merge #544 (which looks larger).

stevenkoenig commented 10 years ago

@codersquid Verifying installation instructions is beyond the scope of what I want to do. @gvwilson Should be ready in some minutes (make it an hour ;D).

stevenkoenig commented 10 years ago

@gvwilson If there are no further requests, this should be ready to merge.