arnaucube
arnaucube/thoughtsPublic Self-hosted repository
thoughts/node_modules/mongoose/node_modules/mongodb/CONTRIBUTING.md
node_modules/mongoose/node_modules/mongodb/CONTRIBUTING.mdRaw
 1## Contributing to the driver
 2
 3### Bugfixes
 4
 5- Before starting to write code, look for existing [tickets](https://github.com/mongodb/node-mongodb-native/issues) or [create one](https://github.com/mongodb/node-mongodb-native/issues/new) for your specific issue. That way you avoid working on something that might not be of interest or that has been addressed already in a different branch.
 6- Fork the [repo](https://github.com/mongodb/node-mongodb-native) _or_ for small documentation changes, navigate to the source on github and click the [Edit](https://github.com/blog/844-forking-with-the-edit-button) button.
 7- Follow the general coding style of the rest of the project:
 8  - 2 space tabs
 9  - no trailing whitespace
10  - comma last
11  - inline documentation for new methods, class members, etc
12  - 0 space between conditionals/functions, and their parenthesis and curly braces
13    - `if(..) {`
14    - `for(..) {`
15    - `while(..) {`
16    - `function(err) {`
17- Write tests and make sure they pass (execute `make test` from the cmd line to run the test suite).
18
19### Documentation
20
21To contribute to the [API documentation](http://mongodb.github.com/node-mongodb-native/) just make your changes to the inline documentation of the appropriate [source code](https://github.com/mongodb/node-mongodb-native/tree/master/docs) in the master branch and submit a [pull request](https://help.github.com/articles/using-pull-requests/). You might also use the github [Edit](https://github.com/blog/844-forking-with-the-edit-button) button.
22
23If you'd like to preview your documentation changes, first commit your changes to your local master branch, then execute `make generate_docs`. Make sure you have the python documentation framework sphinx installed `easy_install sphinx`. The docs are generated under `docs/build'. If all looks good, submit a [pull request](https://help.github.com/articles/using-pull-requests/) to the master branch with your changes.