{"parents": [], "prev": {"link": "../api/", "title": "polib API"}, "next": {"link": "../projects/", "title": "Projects using polib"}, "title": "Contributing to polib", "meta": null, "body": "<section id=\"contributing-to-polib\">\n<span id=\"contributing\"></span><h1>Contributing to polib<a class=\"headerlink\" href=\"#contributing-to-polib\" title=\"Link to this heading\">\u00b6</a></h1>\n<p>You are very welcome to contribute to the project!\nThe bugtracker, wiki and mercurial repository can be found at the\n<a class=\"reference external\" href=\"https://github.com/izimobil/polib/\">project\u2019s page</a>.</p>\n<p>New releases are also published at the\n<a class=\"reference external\" href=\"https://pypi.org/project/polib/\">\u201ccheeseshop\u201d (PyPI)</a>.</p>\n<section id=\"how-to-contribute\">\n<h2>How to contribute<a class=\"headerlink\" href=\"#how-to-contribute\" title=\"Link to this heading\">\u00b6</a></h2>\n<p>There are various possibilities to get involved, for example you can:</p>\n<ul class=\"simple\">\n<li><p><a class=\"reference external\" href=\"https://github.com/izimobil/polib/issues/new/\">Report bugs</a>\npreferably with patches if you can</p></li>\n<li><p>Enhance this <a class=\"reference external\" href=\"https://github.com/izimobil/polib/tree/master/docs/\">documentation</a></p></li>\n<li><p><a class=\"reference external\" href=\"https://github.com/izimobil/polib/\">Fork the code</a>, implement new\nfeatures, test and send a pull request</p></li>\n</ul>\n</section>\n<section id=\"running-the-test-suite\">\n<h2>Running the test suite<a class=\"headerlink\" href=\"#running-the-test-suite\" title=\"Link to this heading\">\u00b6</a></h2>\n<p>To run the tests, just type the following on a terminal:</p>\n<div class=\"highlight-default notranslate\"><div class=\"highlight\"><pre><span></span>$ cd /path/to/polib/\n$ ./runtests.sh\n</pre></div>\n</div>\n<p>You can also use tox:</p>\n<div class=\"highlight-default notranslate\"><div class=\"highlight\"><pre><span></span>$ cd /path/to/polib/\n$ pip install tox\n$ tox\n</pre></div>\n</div>\n<p>If you want to generate coverage information:</p>\n<div class=\"highlight-default notranslate\"><div class=\"highlight\"><pre><span></span>$ pip install coverage\n$ ./runtests.sh\n$ coverage html\n</pre></div>\n</div>\n</section>\n</section>\n", "metatags": "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\" />\n", "rellinks": [["genindex", "General Index", "I", "index"], ["projects", "Projects using polib", "N", "next"], ["api", "polib API", "P", "previous"]], "sourcename": "contributing.rst.txt", "toc": "<ul>\n<li><a class=\"reference internal\" href=\"#\">Contributing to polib</a><ul>\n<li><a class=\"reference internal\" href=\"#how-to-contribute\">How to contribute</a></li>\n<li><a class=\"reference internal\" href=\"#running-the-test-suite\">Running the test suite</a></li>\n</ul>\n</li>\n</ul>\n", "display_toc": true, "page_source_suffix": ".rst", "current_page_name": "contributing", "sidebars": ["localtoc.html", "relations.html", "sourcelink.html", "searchbox.html"], "alabaster_version": "1.0.0", "alabaster_version_info": [1, 0, 0]}