diff options
| author | Tom Christie | 2013-12-09 08:46:18 +0000 |
|---|---|---|
| committer | Tom Christie | 2013-12-09 08:46:18 +0000 |
| commit | c1be503308e755d72aae2c9695739bd33631e18b (patch) | |
| tree | 11df9d8efd408241c32b061e8b6d453058d29d73 | |
| parent | e6f6bb5c7e3e882b0215c981e2f2b6a576820100 (diff) | |
| download | django-rest-framework-c1be503308e755d72aae2c9695739bd33631e18b.tar.bz2 | |
Add notes to contributing docs
| -rw-r--r-- | docs/topics/contributing.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/topics/contributing.md b/docs/topics/contributing.md index 77c60fb4..906950bb 100644 --- a/docs/topics/contributing.md +++ b/docs/topics/contributing.md @@ -164,16 +164,20 @@ If you want to draw attention to a note or warning, use a pair of enclosing line --- -## Third party packages +# Third party packages New features to REST framework are generally recommended to be implemented as third party libraries that are developed outside of the core framework. Ideally third party libraries should be properly documented and packaged, and made available on PyPI. -If you have some functionality that you would like to implement as a third party package it's worth contacting the [discussion group][google-group] as others may be willing to get involved. We strongly encourage third party package development and will always try to prioritize time spent helping their development, documentation and packaging. +## Getting started -Once your package is decently documented and available on PyPI open a pull request or issue, and we'll add a link to it from the main documentation. +If you have some functionality that you would like to implement as a third party package it's worth contacting the [discussion group][google-group] as others may be willing to get involved. We strongly encourage third party package development and will always try to prioritize time spent helping their development, documentation and packaging. We recommend the [`django-reusable-app`][django-reusable-app] template as a good resource for getting up and running with implementing a third party Django package. +## Linking to your package + +Once your package is decently documented and available on PyPI open a pull request or issue, and we'll add a link to it from the main REST framework documentation. + [cite]: http://www.w3.org/People/Berners-Lee/FAQ.html [code-of-conduct]: https://www.djangoproject.com/conduct/ [google-group]: https://groups.google.com/forum/?fromgroups#!forum/django-rest-framework |