Skip to content

Commit

Permalink
docs; contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
aheckmann committed Sep 24, 2012
1 parent e6db65f commit 885ea40
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 16 deletions.
16 changes: 1 addition & 15 deletions docs/contributing.jade
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,6 @@ extends layout
block content
h2 Contributing

h3 Bugfixes
:markdown
- Before starting to write code, look for existing [tickets](https://github.com/learnboost/mongoose/issues) or [create one](https://github.com/learnboost/mongoose/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.
- Fork the [repo](https://github.com/learnboost/mongoose) _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.
- Write inline documentation for new methods or class members.
- Write tests and make sure they pass (execute `make test` from the cmd line to run the test suite).
- Follow the general coding style of the rest of the project (comma first, etc).
Please read all about contributing [here](https://github.com/LearnBoost/mongoose/blob/master/CONTRIBUTING.md).

h3 Documentation
:markdown
To contribute to the [API documentation](./api.html) just make your changes to the inline documentation of the appropriate [source code](https://github.com/LearnBoost/mongoose/tree/master/lib) 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.

To contribute to the [guide](./guide.html) or [quick start](./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.

h3 Plugins
:markdown
The [plugins](http://plugins.mongoosejs.com/) site is also an [open source project](https://github.com/aheckmann/mongooseplugins) that you can get involved with. Feel free to fork and improve it as well!
2 changes: 1 addition & 1 deletion docs/includes/nav.jade
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ ul
li
a(href="./plugins.html") plugins
li
a(href="./contributing.html") contributing
a(href="https://github.com/LearnBoost/mongoose/blob/master/CONTRIBUTING.md") contributing
li
a(href="./migration.html") migrating from 2.x
li.api
Expand Down

0 comments on commit 885ea40

Please sign in to comment.