diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..b80324dd8 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,61 @@ +Contributing to MongoEngine +=========================== + +MongoEngine has a large `community +`_ and +contributions are always encouraged. Contributions can be as simple as +minor tweaks to the documentation. Please read these guidelines before +sending a pull request. + +Bugfixes and New Features +------------------------- + +Before starting to write code, look for existing `tickets +`_ or `create one +`_ for your specific +issue or feature request. That way you avoid working on something +that might not be of interest or that has already been addressed. If in doubt +post to the `user group ` + +Supported Interpreters +---------------------- + +PyMongo supports CPython 2.5 and newer. Language +features not supported by all interpreters can not be used. +Please also ensure that your code is properly converted by +`2to3 `_ for Python 3 support. + +Style Guide +----------- + +MongoEngine aims to follow `PEP8 `_ +including 4 space indents and 79 character line limits. + +Testing +------- + +All tests are run on `Travis `_ +and any pull requests are automatically tested by Travis. Any pull requests +without tests will take longer to be integrated and might be refused. + +General Guidelines +------------------ + +- Avoid backward breaking changes if at all possible. +- Write inline documentation for new classes and methods. +- Write tests and make sure they pass (make sure you have a mongod + running on the default port, then execute ``python setup.py test`` + from the cmd line to run the test suite). +- Add yourself to AUTHORS.rst :) + +Documentation +------------- + +To contribute to the `API documentation +`_ +just make your changes to the inline documentation of the appropriate +`source code `_ or `rst file +`_ in a +branch and submit a `pull request `_. +You might also use the github `Edit `_ +button.