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

Clean up 'contributing' section of readme #219

Open
gregjd opened this issue Jan 23, 2018 · 1 comment
Open

Clean up 'contributing' section of readme #219

gregjd opened this issue Jan 23, 2018 · 1 comment

Comments

@gregjd
Copy link
Member

gregjd commented Jan 23, 2018

The Contributing section of the readme is perhaps a bit overwhelming for someone who's a first-timer looking to see how to work on the website.

Thing big issue that I see is that it presents people with three choices on how to get the site running locally, which might be a bit overwhelming / confusing to someone who might not even understand what all of the options mean.

I'm not 100% on the best way to address this. Personally, I've never used Docker for working on codefordc.org, instead just running Jekyll locally. That has seemed to me to be the easiest way to do things. Is it genuinely easier if you use Docker? (If we do show multiple options, I'd make it very clear that one is the recommended option.)

@stvnrlly
Copy link
Member

Looking at the instructions again (I think I wrote most of them), I think they're probably both too much and unhelpful.

The reason that those instructions are there is the number of people who wanted to make a change to the site and had a rough time just installing Jekyll. But I think trying to teach them package management in this README is probably a mistake.

Looking at the 18F site's README, it hits a couple options but still reads very cleanly. That might be a good model. For those who are interested in more, there's a separate CONTRIBUTING.md that goes in depth.

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