CKAN
  • Overview
  • User guide
    • What is CKAN?
    • Using CKAN
  • Sysadmin guide
    • Creating a sysadmin account
    • Customizing look and feel
    • Managing organizations and datasets
    • Permanently deleting datasets
    • Managing users
  • Maintainer’s guide
    • Installing CKAN
    • Upgrading CKAN
    • Getting started
    • Command Line Interface
    • Organizations and authorization
    • Data preview and visualization
    • FileStore and file uploads
    • DataStore extension
    • Apps & Ideas
    • Tag Vocabularies
    • Form Integration
    • Linked Data and RDF
    • Background tasks
    • Email notifications
    • Page View Tracking
    • Multilingual Extension
    • Stats Extension
    • Configuration Options
    • Multicore Solr setup
  • API guide
    • Legacy APIs
    • Making an API request
    • Example: Importing datasets with the CKAN API
    • API versions
    • Authentication and API keys
    • GET-able API functions
    • JSONP support
    • API Examples
    • Action API reference
  • Extending guide
    • Writing extensions tutorial
    • Using custom config settings in extensions
    • Making configuration options runtime-editable
    • Testing extensions
    • Best practices for writing extensions
    • Customizing dataset and resource metadata fields using IDatasetForm
    • Plugin interfaces reference
    • Plugins toolkit reference
    • Validator functions reference
  • Theming guide
    • Customizing CKAN’s templates
    • Adding static files
    • Customizing CKAN’s CSS
    • Adding CSS and JavaScript files using Fanstatic
    • Customizing CKAN’s JavaScript
    • Best practices for writing CKAN themes
    • Custom Jinja2 tags reference
    • Variables and functions available to templates
    • Objects and methods available to JavaScript modules
    • Template helper functions reference
    • Template snippets reference
    • JavaScript sandbox reference
    • JavaScript API client reference
    • CKAN jQuery plugins reference
  • Contributing guide
    • Reporting issues
    • Translating CKAN
    • Testing CKAN
    • Writing commit messages
    • Making a pull request
    • Reviewing and merging a pull request
    • Writing documentation
    • Projects for beginner CKAN developers
    • CKAN code architecture
    • CSS coding standards
    • HTML coding standards
    • JavaScript coding standards
    • Python coding standards
    • String internationalization
    • Testing coding standards
    • Frontend development guidelines
    • Database migrations
    • Upgrading CKAN’s dependencies
    • Doing a CKAN release
  • Changelog
 
CKAN
  • Docs »
  • Contributing guide
  • Edit on GitHub

Contributing guideΒΆ

CKAN is free open source software and contributions are welcome, whether they’re bug reports, source code, documentation or translations. The following sections will walk you through our processes for making different kinds of contributions to CKAN:

  • Reporting issues
  • Translating CKAN
  • Testing CKAN
  • Writing commit messages
  • Making a pull request
  • Reviewing and merging a pull request
  • Writing documentation
  • Projects for beginner CKAN developers
  • CKAN code architecture
  • CSS coding standards
  • HTML coding standards
  • JavaScript coding standards
  • Python coding standards
  • String internationalization
  • Testing coding standards
  • Frontend development guidelines
  • Database migrations
  • Upgrading CKAN’s dependencies
  • Doing a CKAN release
Next Previous

An Open Knowledge Foundation project.

© 2009-2013, Open Knowledge Foundation. Licensed under Creative Commons Attribution ShareAlike (Unported) v3.0 License.
CC License Logo {{ _('Open Content') }}

Source — Issues — Mailing List — Twitter @CKANProject

Related Projects: The DataHub — DataCatalogs.org — OpenSpending.org — Open Data Handbook

Sphinx theme provided by Read the Docs
Read the Docs v: ckan-2.4.9
Versions
latest
ckan-2.7.1
ckan-2.6.4
ckan-2.5.7
ckan-2.4.9
ckan-2.3.5
ckan-2.2.3
ckan-2.1.5
ckan-2.0.7
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.