Code Monkey home page Code Monkey logo

devdocs's Introduction

rehabstudio DevDocs

This repository provides (or will provide, once it's a bt more complete) a central platform to host all our development guidelines and agreed coding standards for our entire stack.

These docs are hosted on Read The Docs at: http://devdocs.rehabstudio.com

Prerequisites

In order to build and use this documentation locally you'll need a standard Python 2.7 environment set up with virtualenv (and ideally virtualenvwrapper) installed. Installing and using those tools is outside the scope of this guide, but you can find detailed guides for your platform at http://docs.python-guide.org.

For ubuntu this is as simple as sudo apt-get install python-dev virtualenvwrapper, other platforms may differ.

Simple instructions on the usage of virtualenvwrapper can be found at http://docs.python-guide.org/en/latest/dev/virtualenvs/#id3.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Ready to contribute? Here's how to set up rehabstudio/devdocs for local development.

  1. Fork the rehabstudio/devdocs repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/devdocs.git
    $ cd devdocs/
    
  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development (Note that you should not need to use sudo at this point):

    $ mkvirtualenv devdocs
    $ pip install -r requirements.txt
    
  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature
    

    Now you can make your changes locally.

  5. Build your new changes to test locally:

    $ make html
    

    Or if you prefer, run the included watch.sh script to continually monitor your repo for changes and rebuild as required:

    $ ./watch.sh
    
  6. You can run a simple HTTP server locally (probably in another terminal) to view your changes:

    $ cd build/html && python -m SimpleHTTPServer
    
  7. Commit your changes and push your branch to GitHub:

    $ git add .
    $ git commit -m "Your detailed description of your changes."
    $ git push origin name-of-your-bugfix-or-feature
    
  8. Submit a pull request through the GitHub website.

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.