Coder Social home page Coder Social logo

zip-home's Introduction

ZIP homepage opensource project

This is the home of ZIP - the best startup incubator in the world! It is an open source project created by our awesome community! Check it out! :)

Getting started

This project is riding Ruby on Rails. To start contributing you should have installed:

  • Ruby programming language - version 1.9.3-p125 or higher (not tested with ruby2.0)
  • RVM - Ruby Version Manager
  • Git - for version control
  • Rubygems - for all those precious gems
  • Rails - this project is tested using version Rails 3.2.13

Contributing

So, you finally realised the awesomeness scope of ZIP and are now ready to contribute. Bless you. Just keep the following in mind:

  • Contributions will not be accepted without tests. Please stay in the confines of the current test suite and use Rspec
  • Please follow the Github Ruby Styleguide when modifying Ruby code.

Test dependencies

To run the test suite you'll need to install dependencies. ZIP-home uses Bundler, so a quick run of the bundle command and you're all set!

$ bundle

Before you start, run the tests and make sure that they pass (to confirm your environment is configured properly):

$ rspec

Workflow

Here's the most direct way to get your work merged into the project:

  • Fork the project.
  • Clone down your fork ( git clone git://github.com//zip-home.git ).
  • Create a topic branch to contain your change ( git checkout -b my_awesome_feature ).
  • Add tests and hack away, add tests.
  • Make sure everything still passes by running rspec.
  • If necessary, rebase your commits into logical chunks, without errors.
  • Push the branch up ( git push origin my_awesome_feature ).
  • Create a pull request against ofcan/zip-home and describe what your change does and the why you think it should be merged.

In the end...

... hacking on ZIP-home should be fun. If you find any of this hard to figure out, let us know so we can improve our process or documentation! Thanks!

zip-home's People

Contributors

ofcan avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

ddelimar

zip-home's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.