Skip to content

Instantly share code, notes, and snippets.

@rueckstiess
Created March 12, 2015 01:47
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rueckstiess/e1acd468f0138c3608ea to your computer and use it in GitHub Desktop.
Save rueckstiess/e1acd468f0138c3608ea to your computer and use it in GitHub Desktop.
mongodb-js admission structure
# Admission Guidelines for contributions to mongodb-js

## Organization Toolchain

- explain mongodb-js setup  

## All repositories

- requirements: you MUST follow these steps
    - documentation
    - code style guide / conventions
    - tests
    - code coverage

- available options: you CAN use these features

### CLI 

- a command line tool installable with npm 
- some requirements for usability (must have --help, docopt?)

### SPA

- a single-page application running entirely on the client
- may use mongodb-client to communicate with a mongodb-server
- optional: can be browserified and packed up into a single self-containing html 

### Server/Client App

## How to create a new project in mongodb-js

- use `mj create`

## How to port an existing project into mongodb-js

- use `mj ingest`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment