forked from extern/django-helpdesk
Update CONTRIBUTING
This commit is contained in:
parent
a10a597b3a
commit
ba9c6b31bf
112
CONTRIBUTING.rst
112
CONTRIBUTING.rst
@ -1,6 +1,10 @@
|
|||||||
Contributing
|
Contributing
|
||||||
============
|
============
|
||||||
|
|
||||||
|
We're really glad you're reading this and considering contributing to
|
||||||
|
`django-helpdesk`! As an open source project, we rely on volunteers
|
||||||
|
to improve and grow the project. Welcome!
|
||||||
|
|
||||||
django-helpdesk is an open-source project and as such contributions from the
|
django-helpdesk is an open-source project and as such contributions from the
|
||||||
community are welcomed and encouraged!
|
community are welcomed and encouraged!
|
||||||
|
|
||||||
@ -10,38 +14,20 @@ repository is available at:
|
|||||||
|
|
||||||
https://github.com/django-helpdesk/django-helpdesk
|
https://github.com/django-helpdesk/django-helpdesk
|
||||||
|
|
||||||
Licensing
|
|
||||||
---------
|
|
||||||
|
|
||||||
All contributions to django-helpdesk *must* be under the BSD license documented
|
Testing
|
||||||
in the LICENSE file in the top-level directory of this project.
|
-------
|
||||||
|
|
||||||
By submitting a contribution to this project (in any way: via e-mail,
|
If you don't mind testing pre-releases (don't use in production!), we appreciate
|
||||||
via GitHub pull requests, ticket attachments, etc), you acknowledge that your
|
continuous feedback on the `develop` branch, which is our work toward the next
|
||||||
contribution is open-source and licensed under the BSD license.
|
major release. Please file bug reports, and tag the report with the "pre-release"
|
||||||
|
tag.
|
||||||
|
|
||||||
If you or your organisation does not accept these license terms then we cannot
|
This is an easy way to get involved that doesn't require programming.
|
||||||
accept your contribution. Please reconsider!
|
|
||||||
|
|
||||||
Ways to Contribute
|
|
||||||
------------------
|
|
||||||
|
|
||||||
We're happy to include any type of contribution! This can be:
|
Pull Requests
|
||||||
|
-------------
|
||||||
* back-end python/django code development
|
|
||||||
* front-end web development (HTML/Javascript, especially jQuery)
|
|
||||||
* language translations
|
|
||||||
* writing improved documentation and demos
|
|
||||||
|
|
||||||
More details on each of theses tasks is below.
|
|
||||||
|
|
||||||
If you have any questions on contributing, please start a discussion on
|
|
||||||
the GitHub issue tracker at
|
|
||||||
|
|
||||||
https://github.com/django-helpdesk/django-helpdesk/issues
|
|
||||||
|
|
||||||
Back-end Python/Django
|
|
||||||
``````````````````````
|
|
||||||
|
|
||||||
Please fork the project on GitHub, make your changes, and submit a
|
Please fork the project on GitHub, make your changes, and submit a
|
||||||
pull request back into the appropriate branch of the
|
pull request back into the appropriate branch of the
|
||||||
@ -89,8 +75,35 @@ If your changes affect the Django models for `django-helpdesk`, be aware
|
|||||||
that your commits should include database schema python scripts; see the
|
that your commits should include database schema python scripts; see the
|
||||||
Database Schema Changes section below for more details.
|
Database Schema Changes section below for more details.
|
||||||
|
|
||||||
|
|
||||||
|
Coding Conventions
|
||||||
|
------------------
|
||||||
|
|
||||||
|
Be sure all Python code follows PEP8 conventions.
|
||||||
|
|
||||||
|
Ideally, add comments and documentation whenever you touch code.
|
||||||
|
|
||||||
|
HTML and Javascript templates should be appropriately indented.
|
||||||
|
|
||||||
|
|
||||||
|
Database schema changes
|
||||||
|
-----------------------
|
||||||
|
|
||||||
|
As well as making your normal code changes to ``models.py``, please generate a
|
||||||
|
Django migration file and commit it with your code. You will want to use a
|
||||||
|
command similar to the following::
|
||||||
|
|
||||||
|
./manage.py migrate helpdesk --auto [migration_name]
|
||||||
|
|
||||||
|
Make sure that ``migration_name`` is a sensible single-string explanation of
|
||||||
|
what this migration does, such as *add_priority_options* or *add_basket_table*.
|
||||||
|
|
||||||
|
This will add a file to the ``migrations/`` folder, which must be committed to
|
||||||
|
git with your other code changes.
|
||||||
|
|
||||||
|
|
||||||
Tests
|
Tests
|
||||||
.....
|
-----
|
||||||
|
|
||||||
Currently, test coverage is very low. We're working on increasing this, and to
|
Currently, test coverage is very low. We're working on increasing this, and to
|
||||||
make life easier we are using Travis CI (http://travis-ci.org/) for continuous
|
make life easier we are using Travis CI (http://travis-ci.org/) for continuous
|
||||||
@ -118,23 +131,27 @@ start a discussion on the GitHub issue tracker at
|
|||||||
|
|
||||||
https://github.com/django-helpdesk/django-helpdesk/issues
|
https://github.com/django-helpdesk/django-helpdesk/issues
|
||||||
|
|
||||||
Database schema changes
|
|
||||||
.......................
|
|
||||||
|
|
||||||
As well as making your normal code changes to ``models.py``, please generate a
|
Ways to Contribute
|
||||||
Django migration file and commit it with your code. You will want to use a
|
------------------
|
||||||
command similar to the following::
|
|
||||||
|
|
||||||
./manage.py migrate helpdesk --auto [migration_name]
|
We're happy to include any type of contribution! This can be:
|
||||||
|
|
||||||
Make sure that ``migration_name`` is a sensible single-string explanation of
|
* back-end python/django code development
|
||||||
what this migration does, such as *add_priority_options* or *add_basket_table*.
|
* front-end web development (HTML/Javascript, especially jQuery)
|
||||||
|
* language translations
|
||||||
|
* writing improved documentation and demos
|
||||||
|
|
||||||
|
More details on each of theses tasks is below.
|
||||||
|
|
||||||
|
If you have any questions on contributing, please start a discussion on
|
||||||
|
the GitHub issue tracker at
|
||||||
|
|
||||||
|
https://github.com/django-helpdesk/django-helpdesk/issues
|
||||||
|
|
||||||
This will add a file to the ``migrations/`` folder, which must be committed to
|
|
||||||
git with your other code changes.
|
|
||||||
|
|
||||||
Translations
|
Translations
|
||||||
````````````
|
------------
|
||||||
|
|
||||||
Although `django-helpdesk` has originally been written for the English language,
|
Although `django-helpdesk` has originally been written for the English language,
|
||||||
there are already multiple community translations, including Spanish, Polish,
|
there are already multiple community translations, including Spanish, Polish,
|
||||||
@ -149,4 +166,19 @@ project:
|
|||||||
http://www.transifex.net/projects/p/django-helpdesk/resource/core/
|
http://www.transifex.net/projects/p/django-helpdesk/resource/core/
|
||||||
|
|
||||||
Once you have translated content via Transifex, please raise an issue on the
|
Once you have translated content via Transifex, please raise an issue on the
|
||||||
project Github page to let us know it's ready to import.
|
project Github page and tag it as "translations" to let us know it's ready to
|
||||||
|
import.
|
||||||
|
|
||||||
|
|
||||||
|
Licensing
|
||||||
|
---------
|
||||||
|
|
||||||
|
All contributions to django-helpdesk *must* be under the BSD license documented
|
||||||
|
in the LICENSE file in the top-level directory of this project.
|
||||||
|
|
||||||
|
By submitting a contribution to this project (in any way: via e-mail,
|
||||||
|
via GitHub pull requests, ticket attachments, etc), you acknowledge that your
|
||||||
|
contribution is open-source and licensed under the BSD license.
|
||||||
|
|
||||||
|
If you or your organization does not accept these license terms then we cannot
|
||||||
|
accept your contribution. Please reconsider!
|
||||||
|
Loading…
Reference in New Issue
Block a user