gulpjs / gulpjs.github.io

The gulp website
http://gulpjs.com
45 stars 44 forks source link

Add readme explaining how to work on the site #45

Closed phated closed 7 years ago

phated commented 7 years ago

We've been receiving some questions on how to work on the site. We should have a readme describing the workflow (non-build process, static site). Ref https://github.com/gulpjs/gulpjs.github.io/issues/39#issuecomment-270990942 for the simplest explanation.

yocontra commented 7 years ago

@phated One thing to note is not writing custom CSS wherever possible and not touching primitives.

Seeing a lot of PRs writing shitloads of custom CSS that doesn't match the rest of the site, overriding shit like .col-4 globally, etc.

ansballard commented 7 years ago

https://github.com/bdougie/gulpjs.github.io/blob/code/README.md This seems like a good starting point. Needs the screenshot updated but it gives you a structure to build on.

yocontra commented 7 years ago

@ansballard Feel free to submit a PR - screenshot + "clone and open index.html" should be enough instruction

phated commented 7 years ago

That's the old readme, right? The screenshot is wrong and stuff. Needs a complete overhaul and probably should be done from scratch.

code4cake commented 7 years ago

Hey could I work on this one? Thanks

yocontra commented 7 years ago

@dantesolis Feel free to work on it and send a PR!

code4cake commented 7 years ago

oh fudge I think I took a bit too long solving this issue, @saturate already took care of this.

Saturate commented 7 years ago

Yeah @dantesolis if you snooze you lose ;-) but feel free to review it!