diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1b81569a..4a706822 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -27,6 +27,7 @@ Ways to Contribute ------------------ We're happy to include any type of contribution! This can be: + * back-end python/django code development * front-end web development (HTML/Javascript, especially jQuery) * language translations @@ -46,10 +47,12 @@ pull request back into the appropriate branch of the django-helpdesk repository. In general, we use the following git branching scheme: + * `master` always refers to development for the next major release -* major releases are found in their own branches -** `0.2.x` is the branch for the 0.2 release and any bugfix releases -** `0.1` is the branch for the legacy code; it is no longer supported +* major releases are found in their own branches: + + * `0.2.x` is the branch for the 0.2 release and any bugfix releases + * `0.1` is the branch for the legacy code; it is no longer supported If you are submitting a patch for a 0.2 release, apply your pull request to the `0.2.x` branch. If you are helping develop the next release, diff --git a/README.rst b/README.rst index 062d8b2a..4b1822c8 100644 --- a/README.rst +++ b/README.rst @@ -52,7 +52,7 @@ The demo project uses `sqlite` as its database. Sqlite does not allow case-insensitive searches and so the search function may not work as effectively as it would on other database such as PostgreSQL or MySQL that does support case-insensitive searches. -For more information, see [this note in the Django documentation](http://docs.djangoproject.com/en/dev/ref/databases/#sqlite-string-matching). +For more information, see this note_ in the Django documentation. When you try to do a keyword search using `sqlite`, a message will be displayed to alert you to this shortcoming. There is no way around it, sorry. @@ -61,6 +61,7 @@ Installation ------------ `django-helpdesk` requires: + * Django 1.11.x *only* * either Python 2.7 or 3.4+ @@ -108,9 +109,12 @@ Contributing ------------ We're happy to include any type of contribution! This can be: + * back-end python/django code development * front-end web development (HTML/Javascript, especially jQuery) * language translations * writing improved documentation and demos For more information on contributing, please see the `CONTRIBUTING.rst` file. + +.. _note: http://docs.djangoproject.com/en/dev/ref/databases/#sqlite-string-matching