Skip to content

Conversation

ghost
Copy link

@ghost ghost commented Mar 9, 2017

Please replace these instructions with a description of your change. The
'New Fields Only' section should be removed if your pull request
doesn't add any new fields.

Thanks for your contribution!

A checklist is included below which helps us keep the code contributions
consistent and helps speed up the review process. You can add additional
commits to your pull request if you haven't met all of these points on your
first version.

All Changes

  • Add an entry to the docs/changelog.rst describing the change.

  • Add an entry for your name in the docs/authors.rst file if it's not
    already there.

  • Adjust your imports to a standard form by running this command:

    `isort --recursive --line-width 120 localflavor tests`
    

New Fields Only

  • Prefix the country code to all fields.

  • Field names should be easily understood by developers from the target
    localflavor country. This means that English translations are usually
    not the best name unless it's for something standard like postal code,
    tax / VAT ID etc.

  • Prefer 'PostalCodeField' for postal codes as it's
    international English; ZipCode is a term specific to the United
    States postal system.

  • Add meaningful tests. 100% test coverage is not required but all
    validation edge cases should be covered.

  • Add .. versionadded:: <next-version> comment markers to new
    localflavors.

  • Add documentation for all fields.

@ghost ghost closed this Mar 9, 2017
@ghost ghost reopened this Mar 9, 2017
@benkonrath
Copy link
Member

Thanks for your contribution! The first thing you need to do is fix the failing tests. You can see the output of the Travis test jobs by clicking the red x above. You can also run the tests locally.

Once the tests are passing, I'll review your code to see if I can suggest any improvements before this pull request is merged.

@ghost
Copy link
Author

ghost commented Jul 17, 2017

thanks for helping me i try my best

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant