extern/django-helpdesk
1
0
Fork 1
mirror of https://github.com/django-helpdesk/django-helpdesk.git synced 2024-10-05 09:52:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add basic documentation on contributing, including using Transifex for translation.

Browse Source
This commit is contained in:
Ross Poulton 2011-02-25 22:48:40 +00:00
parent b801b184e4
commit 4052518957
2 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/contributing.rst Normal file
View File

@ -0,0 +1,31 @@
Contributing
============
django-helpdesk is an open-source project and as such contributions from the community are welcomed and encouraged.
Licensing
---------
All contributions to django-helpdesk must be under the BSD license documented in our :doc:`license` page. All code submitted (in any way: via e-mail, via GitHub forks, attachments, etc) are assumed to be open-source and licensed under the BSD license.
If you or your organisation does not accept these license terms then we cannot accept your contribution. Please reconsider!
Translations
------------
Although django-helpdesk has originally been written for the English language, there are already multiple translations to Spanish, Polish, and German and more translations are welcomed.
Translations are handled using the excellent Transifex service which is much easier for most users than manually editing .po files. It also allows collaborative translation. If you want to help translate django-helpdesk into languages other than English, we encourage you to make use of our Transifex project:
http://www.transifex.net/projects/p/django-helpdesk/resource/core/
Code changes
------------
Please fork the project on GitHub, make your changes, and log a pull request to get the changes pulled back into my repository.
Wherever possible please break git commits up into small chunks that are specific to a single bit of functionality. For example, a commit should not contain both new functionality *and* a bugfix; the new function and the bugfix should be separate commits wherever possible.
Commit messages should also explain *what*, precisely, has been changed.
If you have any questions, please contact the project co-ordinator, Ross Poulton, at ross@rossp.org.

1
docs/index.rst
View File

@ -81,4 +81,5 @@ Contents:
spam
custom_fields
api
contributing