Copyright and other protections apply. Please see the accompanying LICENSE and CREDITS file(s) for rights and restrictions governing use of this software. All rights not expressly waived or licensed are reserved. If those files are missing or appear to be modified from their originals, then please contact the author before viewing or using this software in any capacity.

Contributing to django-emojiwatch

There are several ways you can contribute.

Filing Issues

You can file new issues as you find them. Please avoid duplicating issues. “Writing Effective Bug Reports” by Elisabeth Hendrickson (PDF) may be helpful.

Submission Guidelines

If you’re willing and able, consider submitting a pull request (PR) with a fix. There are only a few guidelines:

  • If it isn’t already there, please add your name (and optionally your GitHub username, email, website address, or other contact information) to the CREDITS file:

    ...
*   `Gordon the Turtle <https://github.com/GordonTheTurtle>`_
...

  • Try to follow the source conventions as you observe them. (Note: I have purposely avoided aspects of PEP8, in part because I have adopted conventions developed from my experiences with other languages, but mostly because I’m growing older and more stubborn.)

  • Provide tests where feasible and appropriate. At the very least, existing tests should not fail. (There are exceptions, but if there is any doubt, they probably don’t apply.)

    Unit tests live in ./tests. Tests can be run with tox [-e TOX_ENV] (requires Tox) or "${PYTHON:-python}" setup.py test.

    There are two helper scripts that may be of interest. To set up a virtual environment (via virtualenv) for development and to run unit tests using Tox from that virtual environment, you can do the following:

    ( . ./helpers/venvsetup.sh && ./helpers/runtests.sh [-e TOX_ENV] )

  • If you need me, mention me (@posita) in your comment, and describe specifically how I can help.

  • If you want feedback on a work-in-progress (WIP), create a PR and prefix its title with something like, “NEED FEEDBACK -“.
  • If your PR is still in progress, but you aren’t blocked on anything, prefix the title with something like, “WIP -“.
  • Once you’re ready for a merge, resolve any merge conflicts, squash your commits, and provide a useful commit message. (This and this may be helpful.) Then prefix the PR’s title to something like, “READY FOR MERGE -“. I’ll try to get to it as soon as I can.