| 1 | # Contributing
|
| 2 |
|
| 3 | Great to have you here. These are a few ways you can help make this project better:
|
| 4 |
|
| 5 | - [Implement a #starter feature](http://github.com/mongodb-js/mongodb-collection-sample/labels/starter)
|
| 6 | - Add an example to `README.md`
|
| 7 |
|
| 8 | ## Workflow
|
| 9 |
|
| 10 | 1. [Fork the repository on GitHub](http://github.com/mongodb-js/mongodb-collection-sample)
|
| 11 | 1. Create a new branch with a name that breifly describes your feature
|
| 12 | 1. Implement your feature or bug fix
|
| 13 | 1. Add new cases to `./test/index.test.js` and run them with `npm test`
|
| 14 | 1. Add comments around your new code that explain what's happening
|
| 15 | 1. Commit and push your changes to your branch
|
| 16 | 1. Submit a pull request
|
| 17 |
|
| 18 | Don’t get discouraged! We estimate that the response time from the
|
| 19 | maintainers is less than 24 hours.
|
| 20 |
|
| 21 | ## Bugs
|
| 22 |
|
| 23 | You can report new bugs by
|
| 24 | [creating a new issue](http://github.com/mongodb-js/mongodb-collection-sample/issues).
|
| 25 | Please include as much information as possible about your environment
|
| 26 | ("I am using node.js v 0.12.0 on OSX Mavericks"). Actual code is always
|
| 27 | more valuable than an explanation, so please include a link to a GitHub
|
| 28 | gist or include a snippet directly in your issue description.
|
| 29 |
|
| 30 | ## Versioning
|
| 31 |
|
| 32 | This library aims to adhere to [Semantic Versioning2.0.0](http://semver.org/).
|
| 33 | Violations of this scheme should be reported as bugs. Specifically, if a
|
| 34 | minor or patch version is released that breaks backward compatibility,
|
| 35 | that version should be immediately yanked and/or a new version should be
|
| 36 | immediately released that restores compatibility.
|