Commits

Mark Lavin committed db76762

Add contributing guide. Fixes #4.

Comments (0)

Files changed (4)

             (r'^selectable/', include('selectable.urls')),
         )
 
+
+Contributing
+--------------------------------------
+
+If you think you've found a bug or are interested in contributing to this project
+check out our :ref:`contributing guide <contributing-guide>`.
+

docs/contribute.rst

+.. _contributing-guide:
+
+Contributing
+==================
+
+There are plenty of ways to contribute to this project. If you think you've found
+a bug please submit an issue. If there is a feature you'd like to see then please
+open an ticket proposal for it. If you've come up with some helpful examples then
+you can add to our example project.
+
+
+Getting the Source
+--------------------------------------
+
+The source code is hosted on `Bitbucket <https://bitbucket.org/mlavin/django-selectable>`_.
+You can download the full source by cloning the hg repo::
+
+    hg clone https://bitbucket.org/mlavin/django-selectable
+
+Feel free to fork the project and make your own changes. If you think that it would
+be helpful for other then please submit a pull request to have it merged in.
+
+
+Submit an Issue
+--------------------------------------
+
+The issues are also managed on `Bitbucket <https://bitbucket.org/mlavin/django-selectable/issues>`_.
+If you think you've found a bug it's helpful if you indicate the version of django-selectable
+you are using the ticket version flag. If you think your bug is javascript related it is
+also helpful to know the version of jQuery, jQuery UI, and the browser you are using.
+
+Issues are also used to track new features. If you have a feature you would like to see
+you can submit a proposal ticket. You can also see features which are planned here.
+
+
+Running the Test Suite
+--------------------------------------
+
+There are a number of tests in place to test the server side code for this
+project. To run the tests you need Django installed and run::
+
+    python selectable/tests/runtests.py
+
+Tests for the client side code is planned. If javascript testing is something you
+are familiar with then it would be a great help to this project.
+
+
+Building the Documentation
+--------------------------------------
+
+The documentation is built using `Sphinx <http://sphinx.pocoo.org/>`_ 
+and available on `Read the Docs <http://django-selectable.readthedocs.org/>`_. With
+Sphinx installed you can build the documentation by running::
+
+    make html
+
+inside the docs directory. Documentation fixes and improvements are always welcome.
+
     fields
     widgets
     settings
+    contribute
     releases
 
 

docs/overview.rst

 Much of the work here was inspired by things that I like (and things I don't like) about
 `django-ajax-selects <http://code.google.com/p/django-ajax-selects/>`_. To see some of the
 other Django apps for handling auto-completion see `Django-Packages <http://djangopackages.com/grids/g/auto-complete/>`_.
-
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.