search

stitchfix / stitchfix.github.io

15 stars 4 forks source link

guidelines for open-source repos #112

Closed davetron5000 closed 8 years ago

davetron5000 commented 8 years ago

Ping @simeonwillbanks @yorthehunter @codevelvet @webdestroya and whoever else I'm forgetting (I guess we need a GitHub group?)

It's not the most aesthetically pleasing:

stitch_fix_technology

codevelvet commented 8 years ago

That or we could link to a CONTRIBUTING.md.example and a live version

davetron5000 commented 8 years ago

@codevelvet Do you think would work better than showing it inline? I was going for a "copy and paste" thing, but it's pretty darn verbose now so maybe links would be better instead?

codevelvet commented 8 years ago

I think the link would be nice so that people can just download the example file. Then you don't have to worry about copy/pasting into the html, although it shouldn't change that often.

simeonwillbanks commented 8 years ago

@davetron5000 Thanks these guidelines! Please, may we add the README template created by @ndp and myself?

davetron5000 commented 8 years ago

@simeonwillbanks @codevelvet check now. Created /templates that has .txt versions of some artifacts (.txt so jekyll doesn't render them as HTML).

davetron5000 commented 8 years ago

stitch_fix_technology

codevelvet commented 8 years ago

:+1: