search

newhavenio / newhavenio.github.io

active version of the website for newhaven.io built on the Jekyll framework
http://newhavenio.github.io/
MIT License
13 stars 12 forks source link

Add developer guidelines to readme #17

Closed treznick closed 7 years ago

treznick commented 7 years ago

Let's put something in the readme about how we'd like to do development on the site.

lourinaldi commented 7 years ago

Yes, let's.

treznick commented 7 years ago

@lourinaldi that's what you get for commenting :)

sukima commented 7 years ago

Does anyone know what this should say? Do we have any thing established so far?

Also GitHub integrates the concept of development guidelines as a file called CONTRIBUTING.md which is posted in big yellow messages so anyone making a pull request will be asked to read that file. Since this is built in we might wish to use that file convention instead.

https://github.com/blog/1184-contributing-guidelines

danbernier commented 7 years ago

+1 for using CONTRIBUTING.md, makes good sense.

On Fri, Sep 9, 2016 at 8:47 PM, Devin Weaver notifications@github.com wrote:

Does anyone know what this should say? Do we have any thing established so far?

Also GitHub integrates the concept of development guidelines as a file called CONTRIBUTING.md which is posted in big yellow messages so anyone making a pull request will be asked to read that file. Since this is built in we might wish to use that file convention instead.

https://github.com/blog/1184-contributing-guidelines

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/newhavenio/newhavenio.github.io/issues/17#issuecomment-246076226, or mute the thread https://github.com/notifications/unsubscribe-auth/AAAzFS1JWO4icjbLYHttUm40mm6ASn1Wks5qof4zgaJpZM4Jlc5G .

twitter @danbernier http://wordcram.org | http://newhaven.io

treznick commented 7 years ago

Agreed. Basically I'd say if you want to contribute:

  1. Fork the repo
  2. setup your local environment
  3. Make your additions, with tests if appropriate (e.g. new JS behavior/fixing bugs. Content changes or fixes to typos etc. don't require testing)
  4. make a pull request
  5. :cake:

On Fri, Sep 9, 2016 at 10:13 PM, Dan Bernier notifications@github.com wrote:

+1 for using CONTRIBUTING.md, makes good sense.

On Fri, Sep 9, 2016 at 8:47 PM, Devin Weaver notifications@github.com wrote:

Does anyone know what this should say? Do we have any thing established so far?

Also GitHub integrates the concept of development guidelines as a file called CONTRIBUTING.md which is posted in big yellow messages so anyone making a pull request will be asked to read that file. Since this is built in we might wish to use that file convention instead.

https://github.com/blog/1184-contributing-guidelines

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/newhavenio/newhavenio.github. io/issues/17#issuecomment-246076226, or mute the thread https://github.com/notifications/unsubscribe-auth/ AAAzFS1JWO4icjbLYHttUm40mm6ASn1Wks5qof4zgaJpZM4Jlc5G .

twitter @danbernier http://wordcram.org | http://newhaven.io

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/newhavenio/newhavenio.github.io/issues/17#issuecomment-246082095, or mute the thread https://github.com/notifications/unsubscribe-auth/AAlwA-bgHXFwnhlnwF4aM5JclhhZc-1hks5qohJjgaJpZM4Jlc5G .

treznick commented 7 years ago

I've added a CONTRIBUTING.md in #20. It might need some work on the bit that talks about how to set up a development environment. But, since this is all incremental and WIP (and since @maxx1128 kindly merged it [THANKS MAX!!! 🎉 👍 🍰 🍨 🍕]), we can just PR any changes as necessary (because now we have a guide that tells us to do that ;) ). Closing this.