Commits

Kenneth Love committed 281ce56

criteria for the rumble

Comments (0)

Files changed (1)

docs/django_package_thunderdome.rst

 Django Package Thunderdome: Is your package worthy?
 ===================================================
 
-Presented by Audrey Roy
-~~~~~~~~~~~~~~~~~~~~~~~
+Presented by Audrey Roy & Daniel Greenfeld
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+1. Review criteria
 
+    1. Purpose
+
+        * Name should tell you what it does.
+        * Real need and be useful.
+
+    2. Scope
+
+        * Small, narrow focus is better.
+
+    3. Documentation
+
+        * No docs means the package is pre-alpha
+        * Doc strings != documentation
+        * If there are dependencies, they should be in the docs
+        * Installation should be bulletproof
+
+    4. Testing
+
+        * Tests improve reliability
+        * Tests make it easy to advance python/django versions
+        * Tests make it easier for community submissions
+
+    5. Activity
+
+        * When was the last commit?
+        * How frequent are the commits?
+        * Are there periodic version updates?
+
+    6. Community
+
+        * Active leaders
+        * How many contributors?
+        * Proper attribution of authors?
+
+    7. Modularity
+
+        * "Pluggability"
+        * Installation should be minimally invasive
+        * Do not confuse modularity with over-engineering
+
+    8. Availability on PyPI
+
+        * Actually on PyPI
+        * Latest release on PyPI
+            * Should not have to go to repo for working version
+        * Proper version numbers
+
+    9. VCS/Hosting
+
+        * Great: Github/Bitbucket
+        * OK: Launchpad/SourceForge
+        * Outdated: Google project hosting
+        * Poor: Bespoke
+
+    10. License
+
+        * You need a license
+        * Companies prefer BSD or MIT
+        * http://opensource.org/licenses/category
+
+2. Fight!
+