Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve CONTRIBUTING.md #9

Open
fmichonneau opened this issue Apr 18, 2018 · 3 comments
Open

Improve CONTRIBUTING.md #9

fmichonneau opened this issue Apr 18, 2018 · 3 comments
Assignees

Comments

@fmichonneau
Copy link
Contributor

fmichonneau commented Apr 18, 2018

This is an umbrella issue to capture things that should be added/made clearer in the CONTRIBUTING file. Some of the information listed here could also go in The Carpentries handbook depending on the level of details needed. (This issue will be edited as needed).

@rgieseke
Copy link

Being more explicit about the system dependencies and installation instructions to render the website locally (swcarpentry/python-novice-gapminder#306)

The setup.md might also be a good place for such instructions.

@fmichonneau
Copy link
Contributor Author

setup.md is intended for learners and aimed at informing them on how to get their laptop setup before the workshop. Knowing how to render the site is beyond what we teach in workshops.

@rgieseke
Copy link

I see, a link in the Readme to an 'Installation' section in the CONTRIBUTING.md file is probably a good option then.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants