Skip to content

General HDX ckan Contribution Guidelines

mbellotti edited this page Apr 7, 2014 · 2 revisions

When Modifying Templates

  1. Comment out code, don't delete it. You can do this with Jinja2 templates by wrapping the code to be commented out in {# ... #} tags
  2. Modify and recompile language files instead of changing text. Language files can be found ckan/il8n directory. Not all the copy is in the language files (unfortunately) but if you change the copy in the template it will not translate.

When Modifying Functionality

  1. Extend as much as possible
  2. When extension is not possible or not worthwhile label the changed code with a comment specifying that it has been changed, why it was changed, and a commented out record of the original code.