CONTRIBUTING 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. Contributing to the tz code and data
  2. The time zone database is by no means authoritative: governments
  3. change timekeeping rules erratically and sometimes with little
  4. warning, the data entries do not cover all of civil time before
  5. 1970, and undoubtedly errors remain in the code and data. Feel
  6. free to fill gaps or fix mistakes, and please email improvements
  7. to tz@iana.org for use in the future.
  8. To email small changes, please run a POSIX shell command like
  9. 'diff -u old/europe new/europe >myfix.patch', and attach
  10. myfix.patch to the email.
  11. For more-elaborate changes, please read the Theory file and browse
  12. the mailing list archives <http://mm.icann.org/pipermail/tz/> for
  13. examples of patches that tend to work well. Ideally, additions to
  14. data should contain commentary citing reliable sources as
  15. justification.
  16. Please submit changes against either the latest release in
  17. <ftp://ftp.iana.org/tz/> or the master branch of the experimental
  18. Git repository. If you use Git the following workflow may be helpful:
  19. * Copy the experimental repository.
  20. git clone https://github.com/eggert/tz.git
  21. cd tz
  22. * Get current with the master branch.
  23. git checkout master
  24. git pull
  25. * Switch to a new branch for the changes. Choose a different
  26. branch name for each change set.
  27. git checkout -b mybranch
  28. * Edit source files. Include commentary that justifies the
  29. changes by citing reliable sources.
  30. * Debug the changes, e.g.:
  31. make check
  32. make install
  33. ./zdump -v America/Los_Angeles
  34. * For each separable change, commit it in the new branch, e.g.:
  35. git add northamerica
  36. git commit
  37. See recent 'git log' output for the commit-message style.
  38. * Create patch files 0001-*, 0002-*, ...
  39. git format-patch master
  40. * After reviewing the patch files, send the patches to tz@iana.org
  41. for others to review.
  42. git send-email master
  43. * Start anew by getting current with the master branch again
  44. (the second step above).
  45. Please do not create issues or pull requests on GitHub, as the
  46. proper procedure for proposing and distributing patches is via
  47. email as illustrated above.