contributing.rst 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. ===============================
  2. Contributing to django Organice
  3. ===============================
  4. Official repositories: (kept in sync)
  5. #. `Bitbucket`:index:: https://bitbucket.org/bittner/django-organice
  6. #. `GitHub`:index:: https://github.com/bittner/django-organice
  7. Fork any of the repositories, make your code changes or additions, and place a pull request.
  8. Help Wanted
  9. ===========
  10. - Writing tests
  11. - Translations (blog posts, documentation, user interface)
  12. Translation
  13. -----------
  14. Translation is done on `Transifex`_ for both the project text strings and the documentation.
  15. The multilingual documentation is written in `reStructuredText`_ syntax, and built using `Sphinx`_.
  16. As a `translator`:index: you can simply jump on `Transifex`:index: and get your hands dirty for
  17. your language. Some helpful background reading is available from `Read the Docs`_ and
  18. `Transifex support`_.
  19. Bumping Versions, Package, Release
  20. ==================================
  21. As for the `version numbers`:index: of django Organice we use `Semantic Versioning`_. Changes
  22. from one to the next `release`:index: are documented in the :doc:`changelog`.
  23. .. _`Transifex`: https://www.transifex.com/projects/p/django-organice-docs/
  24. .. _`reStructuredText`: http://docutils.sourceforge.net/docs/user/rst/quickref.html
  25. .. _`Sphinx`: http://sphinx-doc.org/intl.html
  26. .. _`Read the Docs`: http://read-the-docs.readthedocs.org/en/latest/i18n.html
  27. .. _`Transifex support`: http://support.transifex.com/customer/portal/articles/972120-introduction-to-the-web-editor
  28. .. _`Semantic Versioning`: http://semver.org/