mirror of
https://github.com/atlanticbiomedical/biomedjs.git
synced 2025-07-02 00:47:26 -04:00
Updated mongoose
This commit is contained in:
6
node_modules/mongoose/CONTRIBUTING.md
generated
vendored
6
node_modules/mongoose/CONTRIBUTING.md
generated
vendored
@ -1,7 +1,5 @@
|
||||
## Contributing to Mongoose
|
||||
|
||||
### STOP!
|
||||
|
||||
If you have a question about Mongoose (not a bug report) please post it to either [StackOverflow](http://stackoverflow.com/questions/tagged/mongoose), our [Google Group](http://groups.google.com/group/mongoose-orm), or on the #mongoosejs irc channel on freenode.
|
||||
|
||||
### Reporting bugs
|
||||
@ -41,7 +39,7 @@ If you have a question about Mongoose (not a bug report) please post it to eithe
|
||||
- execute `npm install` to install the necessary dependencies
|
||||
- execute `make test` to run the tests (we're using [mocha](http://visionmedia.github.com/mocha/))
|
||||
- or to execute a single test `T="-g 'some regexp that matches the test description'" make test`
|
||||
- any mocha flags can be specified with T="..."
|
||||
- any mocha flags can be specified with `T="..."`
|
||||
|
||||
### Documentation
|
||||
|
||||
@ -49,7 +47,7 @@ To contribute to the [API documentation](http://mongoosejs.com/docs/api.html) ju
|
||||
|
||||
To contribute to the [guide](http://mongoosejs.com/docs/guide.html) or [quick start](http://mongoosejs.com/docs/index.html) docs, make your changes to the appropriate `.jade` files in the [docs](https://github.com/LearnBoost/mongoose/tree/master/docs) directory of the master branch and submit a pull request. Again, the [Edit](https://github.com/blog/844-forking-with-the-edit-button) button might work for you here.
|
||||
|
||||
If you'd like to preview your documentation changes, first commit your changes to your local master branch, then execute `make docs` from the project root, which switches to the gh-pages branch, merges from master, and builds all the static pages for you. Now execute `node server.js` from the project root which will launch a local webserver where you can browse the documentation site locally. If all looks good, submit a [pull request](https://help.github.com/articles/using-pull-requests/) to the master branch with your changes.
|
||||
If you'd like to preview your documentation changes, first commit your changes to your local master branch, then execute `make docs` from the project root, which switches to the gh-pages branch, merges from the master branch and builds all the static pages for you. Now execute `node static.js` from the project root which will launch a local webserver where you can browse the documentation site locally. If all looks good, submit a [pull request](https://help.github.com/articles/using-pull-requests/) to the master branch with your changes.
|
||||
|
||||
### Plugins website
|
||||
|
||||
|
Reference in New Issue
Block a user