mobify / stencil

DEPRECIATED - The latest Stencil development is currently taking place in the Adaptive.js repo.
MIT License
4 stars 0 forks source link

Stencil readme update #140

Closed nastiatikk closed 9 years ago

nastiatikk commented 9 years ago

Status: Ready for Review Reviewers: @kpeatt @mlworks @ry5n @avelinet @cole-sanderson @jeffkamo @yourpalsonja

Changes

These are very important rules that all who work with Stencil should know. If we keep them somewhere at the bottom of the page there is a high change for people not notice them. Especially if these are the people who work on Stencil for a while - they simply don't check README anymore.

Todos:

jeffkamo commented 9 years ago

:+1:

jeffkamo commented 9 years ago

Ignore the irony in my typo fix commit message.

ry5n commented 9 years ago

@jeffkamo @nastiatikk @kpeatt I missed that this got merged. I just want to say I don’t think these warnings belong at the top of the readme. Really there should be a top-level section called “Contributing” and yeah put these warnings right at the top of that section but they don’t belong at the top of the file which should speak to end users not maintainers.

Also I don’t think we need to:

I’m not saying we don’t share that knowledge but specific project readmes are not the place to document general git practices. The only warning we really needed to surface better was the one about gh-pages.

nastiatikk commented 9 years ago

I agree that we can to move it down to Contribution section. But still think we need to mention to create PR only from master branch to avoid cases happened with TAB branch when its parent branch was removed

avelinet commented 9 years ago

Maybe rather than include git etiquette/best practices in our readmes it could simply be something that @ry5n touches on in the Stencil workshop he's been talking about putting on?

ry5n commented 9 years ago

Yup we could totally do it there.

nastiatikk commented 9 years ago

What was there? I don't remember Stencil workshop

ry5n commented 9 years ago

Hasn’t happened yet! Something I’d like to do soon. :)