{"result":{"depiction_url":null,"edges":{},"id":1642,"is_a":["text","documentation","developerguide"],"links":[{"rel":"self","target":"https:\/\/zotonic.com\/.zotonic\/websub\/topic\/1642"},{"rel":"hub","target":"https:\/\/zotonic.com\/.zotonic\/websub"}],"medium":null,"medium_url":null,"name":"doc_developerguide_contributing","page_url":{"en":"https:\/\/zotonic.com\/docs\/1642\/contributing-to-zotonic","x-default":"https:\/\/zotonic.com\/docs\/1642\/contributing-to-zotonic"},"preview_url":null,"resource":{"body":"
\n \n
\n\n

We encourage contributions to Zotonic from the community! This chapter describes\nhow you can help improve Zotonic.<\/p>\n

    \n

  1. Fork the zotonic<\/span><\/code> repository on Github (at https:\/\/github.com\/zotonic\/zotonic<\/a>).<\/p>\n<\/li>\n

  2. Clone your fork or add the remote if you already have a clone of\nthe repository:<\/p>\n

    <\/span>git<\/span> clone<\/span> git<\/span>@<\/span>github<\/span>.<\/span>com<\/span>:<\/span>yourusername<\/span>\/<\/span>zotonic<\/span>.<\/span>git<\/span>\n<\/pre><\/div>\n<\/div>\n
    or:<\/p>\n
    <\/span>git<\/span> remote<\/span> add<\/span> mine<\/span> git<\/span>@<\/span>github<\/span>.<\/span>com<\/span>:<\/span>yourusername<\/span>\/<\/span>zotonic<\/span>.<\/span>git<\/span>\n<\/pre><\/div>\n<\/div>\n<\/li>\n
  3. Create a topic branch for your change:<\/p>\n
    <\/span>git<\/span> checkout<\/span> -<\/span>b<\/span> some<\/span>-<\/span>topic<\/span>-<\/span>branch<\/span>\n<\/pre><\/div>\n<\/div>\n<\/li>\n
  4. Make your change and commit. Use a clear and descriptive commit\nmessage, spanning multiple lines if detailed explanation is needed.<\/p>\n<\/li>\n
  5. Push to your fork of the repository and then send a pull-request\nthrough Github:<\/p>\n
    <\/span>git<\/span> push<\/span> mine<\/span> some<\/span>-<\/span>topic<\/span>-<\/span>branch<\/span>\n<\/pre><\/div>\n<\/div>\n<\/li>\n
  6. A Zotonic committer will review your patch and merge it into the\nmain repository or send you feedback. The pull request page on\ngithub is the main place to discuss the code and related topics.<\/p>\n<\/li>\n<\/ol>\n
    \n<\/a>
    Coding standards<\/h2>\n
    The Zotonic code follows Inaka’s Erlang Coding Guidelines<\/a>. This is enforced\nusing the Elvis<\/a> code checking tool. You can check the code locally with:<\/p>\n
    <\/span>$ elvis rock\n<\/pre><\/div>\n<\/div>\n
    When contributing, simply try to follow the coding style as you find it in the\nexisting code.<\/p>\n
    \n
    Emacs<\/h3>\n
    Provided with the Zotonic distribution is a Zotonic template mode,\nzotonic-tpl-mode<\/span><\/code>, which supports the Zotonic flavor of Django.\nIt is located in the priv\/emacs\/zotonic-tpl-mode.el<\/span><\/code> file, and\nmay be installed in emacs by adding something like this to your .emacs<\/cite>\nfile:<\/p>\n
    <\/span>(<\/span>add-to-list<\/span> 'load-path<\/span> "...\/path\/to\/zotonic\/priv\/emacs"<\/span>)<\/span>\n(<\/span>require<\/span> 'zotonic-tpl-mode<\/span>)<\/span>\n;; optional, for associating .tpl files with zotonic-tpl-mode<\/span>\n(<\/span>add-to-list<\/span> 'auto-mode-alist<\/span> '<\/span>(<\/span>"\\\\.tpl$"<\/span> .<\/span> zotonic-tpl-mode<\/span>))<\/span>\n<\/pre><\/div>\n<\/div>\n<\/div>\n<\/div>\n
    \n
    Writing commit messages<\/h2>\n
    The Zotonic commit convention are slightly based on rebar’s README<\/a>.<\/p>\n
    Structure your commit message like this:<\/p>\n
    <\/span>prefix: One line summary (less than 50 characters)\n\nLonger description, multiline text that is supposed to wrap at 72\ncharacters.\n\nFixes #403\n<\/pre><\/div>\n<\/div>\n