{"action":"created","comment":{"url":"https://api.github.com/repos/ged-lab/khmer/pulls/comments/25089901","id":25089901,"diff_hunk":"@@ -0,0 +1,96 @@\n+Command line scripts, ``scripts/``, and ``sandbox/``\n+====================================================\n+\n+.. note::\n+\n+   This document applies through khmer/oxli 2.0/3.0 (see\n+   :doc:`../roadmap`) - we will revisit when the Python API falls\n+   under semantic versioning for oxli 4.0.\n+\n+khmer has two conflicting goals: first, we want to provide a reliable\n+piece of software to our users; and second, we want to be flexible and\n+enable exploration of new algorithms and programs.  To this end,\n+we've split our command line scripts across two directories,\n+``scripts/`` and ``sandbox/``.  The former is the staid, boring, reliable\n+code; the latter is a place for exploration.\n+\n+As a result, we are committed to high test coverage, stringent code\n+review, and `Semantic Versioning <http://semver.org/>`__ for files in\n+``scripts/``, but explicitly *not* committed to this for files and\n+functionality implemented in ``sandbox/``.  So, putting a file into\n+``scripts/`` is a big deal, especially since it increases our maintenance\n+burden for the indefinite future.\n+\n+We've roughed out the following process for moving scripts into ``scripts/``:\n+\n+* Command line scripts start in ``sandbox/``;\n+* Once their utility is proven (in a paper, for example), we can propose to\n+  move them into ``scripts/``;\n+* There's a procedure for moving scripts from ``sandbox/`` into ``scripts/``.\n+\n+Read on!\n+\n+Sandbox script requirements and suggestions\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+All scripts in ``sandbox/`` must:\n+\n+* be importable (enforced by ``test_import_all`` in\n+  ``test_sandbox_scripts.py``)\n+* be mentioned in ``sandbox/README.rst``\n+* have a shebang line ``#! /usr/bin/env python``\n+* be command-line executable (``chmod +x``)","path":"doc/dev/scripts-and-sandbox.txt","position":42,"original_position":42,"commit_id":"9ce38020208fdd30082a3f8e1f549a1919dfd476","original_commit_id":"9ce38020208fdd30082a3f8e1f549a1919dfd476","user":{"login":"mr-c","id":1330696,"avatar_url":"https://avatars.githubusercontent.com/u/1330696?v=3","gravatar_id":"","url":"https://api.github.com/users/mr-c","html_url":"https://github.com/mr-c","followers_url":"https://api.github.com/users/mr-c/followers","following_url":"https://api.github.com/users/mr-c/following{/other_user}","gists_url":"https://api.github.com/users/mr-c/gists{/gist_id}","starred_url":"https://api.github.com/users/mr-c/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mr-c/subscriptions","organizations_url":"https://api.github.com/users/mr-c/orgs","repos_url":"https://api.github.com/users/mr-c/repos","events_url":"https://api.github.com/users/mr-c/events{/privacy}","received_events_url":"https://api.github.com/users/mr-c/received_events","type":"User","site_admin":false},"body":"`chmod u+x`","created_at":"2015-02-20T18:17:10Z","updated_at":"2015-02-20T18:17:10Z","html_url":"https://github.com/ged-lab/khmer/pull/799#discussion_r25089901","pull_request_url":"https://api.github.com/repos/ged-lab/khmer/pulls/799","_links":{"self":{"href":"https://api.github.com/repos/ged-lab/khmer/pulls/comments/25089901"},"html":{"href":"https://github.com/ged-lab/khmer/pull/799#discussion_r25089901"},"pull_request":{"href":"https://api.github.com/repos/ged-lab/khmer/pulls/799"}}},"pull_request":{"url":"https://api.github.com/repos/ged-lab/khmer/pulls/799","id":29711358,"html_url":"https://github.com/ged-lab/khmer/pull/799","diff_url":"https://github.com/ged-lab/khmer/pull/799.diff","patch_url":"https://github.com/ged-lab/khmer/pull/799.patch","issue_url":"https://api.github.com/repos/ged-lab/khmer/issues/799","number":799,"state":"open","locked":false,"title":"Policies for sandbox/ and scripts/ code, together with a process for moving code into scripts/","user":{"login":"ctb","id":51016,"avatar_url":"https://avatars.githubusercontent.com/u/51016?v=3","gravatar_id":"","url":"https://api.github.com/users/ctb","html_url":"https://github.com/ctb","followers_url":"https://api.github.com/users/ctb/followers","following_url":"https://api.github.com/users/ctb/following{/other_user}","gists_url":"https://api.github.com/users/ctb/gists{/gist_id}","starred_url":"https://api.github.com/users/ctb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ctb/subscriptions","organizations_url":"https://api.github.com/users/ctb/orgs","repos_url":"https://api.github.com/users/ctb/repos","events_url":"https://api.github.com/users/ctb/events{/privacy}","received_events_url":"https://api.github.com/users/ctb/received_events","type":"User","site_admin":false},"body":"A draft policy to reflect the issue raised in #471. Ready for review!\r\n\r\nstandard checklist:\r\n- [x] Is it mergable?\r\n- [x] Did it pass the tests?\r\n- [x] If it introduces new functionality in scripts/ is it tested?\r\n  Check for code coverage.\r\n- [x] Is it well formatted? Look at `make pep8`, `make diff_pylint_report`,\r\n  `make cppcheck`, and `make doc` output. Use `make format` and manual\r\n  fixing as needed.\r\n- [x] Did it change the command-line interface? Only additions are allowed\r\n  without a major version increment. Changing file formats also requires a\r\n  major version number increment.\r\n- [x] Is it documented in the ChangeLog?\r\n- [x] Was a spellchecker run on the source code and documentation after\r\n  changes were made?\r\n\r\nAnd I'm also adding:\r\n\r\n- [ ] policy document accurately reflects @mr-c's wishes, perhaps after appropriate cognitive alterations have been performed","created_at":"2015-02-20T16:52:34Z","updated_at":"2015-02-20T18:17:10Z","closed_at":null,"merged_at":null,"merge_commit_sha":"ee78b3722e4b42f25daa3520a11a2d1dcc510bea","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/ged-lab/khmer/pulls/799/commits","review_comments_url":"https://api.github.com/repos/ged-lab/khmer/pulls/799/comments","review_comment_url":"https://api.github.com/repos/ged-lab/khmer/pulls/comments/{number}","comments_url":"https://api.github.com/repos/ged-lab/khmer/issues/799/comments","statuses_url":"https://api.github.com/repos/ged-lab/khmer/statuses/9ce38020208fdd30082a3f8e1f549a1919dfd476","head":{"label":"policy/scripts_and_sandbox","ref":"policy/scripts_and_sandbox","sha":"9ce38020208fdd30082a3f8e1f549a1919dfd476","user":{"login":"ged-lab","id":1740697,"avatar_url":"https://avatars.githubusercontent.com/u/1740697?v=3","gravatar_id":"","url":"https://api.github.com/users/ged-lab","html_url":"https://github.com/ged-lab","followers_url":"https://api.github.com/users/ged-lab/followers","following_url":"https://api.github.com/users/ged-lab/following{/other_user}","gists_url":"https://api.github.com/users/ged-lab/gists{/gist_id}","starred_url":"https://api.github.com/users/ged-lab/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ged-lab/subscriptions","organizations_url":"https://api.github.com/users/ged-lab/orgs","repos_url":"https://api.github.com/users/ged-lab/repos","events_url":"https://api.github.com/users/ged-lab/events{/privacy}","received_events_url":"https://api.github.com/users/ged-lab/received_events","type":"Organization","site_admin":false},"repo":{"id":4331833,"name":"khmer","full_name":"ged-lab/khmer","owner":{"login":"ged-lab","id":1740697,"avatar_url":"https://avatars.githubusercontent.com/u/1740697?v=3","gravatar_id":"","url":"https://api.github.com/users/ged-lab","html_url":"https://github.com/ged-lab","followers_url":"https://api.github.com/users/ged-lab/followers","following_url":"https://api.github.com/users/ged-lab/following{/other_user}","gists_url":"https://api.github.com/users/ged-lab/gists{/gist_id}","starred_url":"https://api.github.com/users/ged-lab/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ged-lab/subscriptions","organizations_url":"https://api.github.com/users/ged-lab/orgs","repos_url":"https://api.github.com/users/ged-lab/repos","events_url":"https://api.github.com/users/ged-lab/events{/privacy}","received_events_url":"https://api.github.com/users/ged-lab/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ged-lab/khmer","description":"In-memory nucleotide sequence k-mer counting, filtering, graph traversal and more","fork":false,"url":"https://api.github.com/repos/ged-lab/khmer","forks_url":"https://api.github.com/repos/ged-lab/khmer/forks","keys_url":"https://api.github.com/repos/ged-lab/khmer/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ged-lab/khmer/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ged-lab/khmer/teams","hooks_url":"https://api.github.com/repos/ged-lab/khmer/hooks","issue_events_url":"https://api.github.com/repos/ged-lab/khmer/issues/events{/number}","events_url":"https://api.github.com/repos/ged-lab/khmer/events","assignees_url":"https://api.github.com/repos/ged-lab/khmer/assignees{/user}","branches_url":"https://api.github.com/repos/ged-lab/khmer/branches{/branch}","tags_url":"https://api.github.com/repos/ged-lab/khmer/tags","blobs_url":"https://api.github.com/repos/ged-lab/khmer/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ged-lab/khmer/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ged-lab/khmer/git/refs{/sha}","trees_url":"https://api.github.com/repos/ged-lab/khmer/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ged-lab/khmer/statuses/{sha}","languages_url":"https://api.github.com/repos/ged-lab/khmer/languages","stargazers_url":"https://api.github.com/repos/ged-lab/khmer/stargazers","contributors_url":"https://api.github.com/repos/ged-lab/khmer/contributors","subscribers_url":"https://api.github.com/repos/ged-lab/khmer/subscribers","subscription_url":"https://api.github.com/repos/ged-lab/khmer/subscription","commits_url":"https://api.github.com/repos/ged-lab/khmer/commits{/sha}","git_commits_url":"https://api.github.com/repos/ged-lab/khmer/git/commits{/sha}","comments_url":"https://api.github.com/repos/ged-lab/khmer/comments{/number}","issue_comment_url":"https://api.github.com/repos/ged-lab/khmer/issues/comments/{number}","contents_url":"https://api.github.com/repos/ged-lab/khmer/contents/{+path}","compare_url":"https://api.github.com/repos/ged-lab/khmer/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ged-lab/khmer/merges","archive_url":"https://api.github.com/repos/ged-lab/khmer/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ged-lab/khmer/downloads","issues_url":"https://api.github.com/repos/ged-lab/khmer/issues{/number}","pulls_url":"https://api.github.com/repos/ged-lab/khmer/pulls{/number}","milestones_url":"https://api.github.com/repos/ged-lab/khmer/milestones{/number}","notifications_url":"https://api.github.com/repos/ged-lab/khmer/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ged-lab/khmer/labels{/name}","releases_url":"https://api.github.com/repos/ged-lab/khmer/releases{/id}","created_at":"2012-05-15T03:52:53Z","updated_at":"2015-02-20T15:44:18Z","pushed_at":"2015-02-20T18:07:14Z","git_url":"git://github.com/ged-lab/khmer.git","ssh_url":"git@github.com:ged-lab/khmer.git","clone_url":"https://github.com/ged-lab/khmer.git","svn_url":"https://github.com/ged-lab/khmer","homepage":"http://khmer.readthedocs.org/","size":149575,"stargazers_count":201,"watchers_count":201,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":153,"mirror_url":null,"open_issues_count":243,"forks":153,"open_issues":243,"watchers":201,"default_branch":"master"}},"base":{"label":"master","ref":"master","sha":"9fbe32e132af62467db5553834acb903dd71d60d","user":{"login":"ged-lab","id":1740697,"avatar_url":"https://avatars.githubusercontent.com/u/1740697?v=3","gravatar_id":"","url":"https://api.github.com/users/ged-lab","html_url":"https://github.com/ged-lab","followers_url":"https://api.github.com/users/ged-lab/followers","following_url":"https://api.github.com/users/ged-lab/following{/other_user}","gists_url":"https://api.github.com/users/ged-lab/gists{/gist_id}","starred_url":"https://api.github.com/users/ged-lab/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ged-lab/subscriptions","organizations_url":"https://api.github.com/users/ged-lab/orgs","repos_url":"https://api.github.com/users/ged-lab/repos","events_url":"https://api.github.com/users/ged-lab/events{/privacy}","received_events_url":"https://api.github.com/users/ged-lab/received_events","type":"Organization","site_admin":false},"repo":{"id":4331833,"name":"khmer","full_name":"ged-lab/khmer","owner":{"login":"ged-lab","id":1740697,"avatar_url":"https://avatars.githubusercontent.com/u/1740697?v=3","gravatar_id":"","url":"https://api.github.com/users/ged-lab","html_url":"https://github.com/ged-lab","followers_url":"https://api.github.com/users/ged-lab/followers","following_url":"https://api.github.com/users/ged-lab/following{/other_user}","gists_url":"https://api.github.com/users/ged-lab/gists{/gist_id}","starred_url":"https://api.github.com/users/ged-lab/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ged-lab/subscriptions","organizations_url":"https://api.github.com/users/ged-lab/orgs","repos_url":"https://api.github.com/users/ged-lab/repos","events_url":"https://api.github.com/users/ged-lab/events{/privacy}","received_events_url":"https://api.github.com/users/ged-lab/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/ged-lab/khmer","description":"In-memory nucleotide sequence k-mer counting, filtering, graph traversal and more","fork":false,"url":"https://api.github.com/repos/ged-lab/khmer","forks_url":"https://api.github.com/repos/ged-lab/khmer/forks","keys_url":"https://api.github.com/repos/ged-lab/khmer/keys{/key_id}","collaborators_url":"https://api.github.com/repos/ged-lab/khmer/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/ged-lab/khmer/teams","hooks_url":"https://api.github.com/repos/ged-lab/khmer/hooks","issue_events_url":"https://api.github.com/repos/ged-lab/khmer/issues/events{/number}","events_url":"https://api.github.com/repos/ged-lab/khmer/events","assignees_url":"https://api.github.com/repos/ged-lab/khmer/assignees{/user}","branches_url":"https://api.github.com/repos/ged-lab/khmer/branches{/branch}","tags_url":"https://api.github.com/repos/ged-lab/khmer/tags","blobs_url":"https://api.github.com/repos/ged-lab/khmer/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/ged-lab/khmer/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/ged-lab/khmer/git/refs{/sha}","trees_url":"https://api.github.com/repos/ged-lab/khmer/git/trees{/sha}","statuses_url":"https://api.github.com/repos/ged-lab/khmer/statuses/{sha}","languages_url":"https://api.github.com/repos/ged-lab/khmer/languages","stargazers_url":"https://api.github.com/repos/ged-lab/khmer/stargazers","contributors_url":"https://api.github.com/repos/ged-lab/khmer/contributors","subscribers_url":"https://api.github.com/repos/ged-lab/khmer/subscribers","subscription_url":"https://api.github.com/repos/ged-lab/khmer/subscription","commits_url":"https://api.github.com/repos/ged-lab/khmer/commits{/sha}","git_commits_url":"https://api.github.com/repos/ged-lab/khmer/git/commits{/sha}","comments_url":"https://api.github.com/repos/ged-lab/khmer/comments{/number}","issue_comment_url":"https://api.github.com/repos/ged-lab/khmer/issues/comments/{number}","contents_url":"https://api.github.com/repos/ged-lab/khmer/contents/{+path}","compare_url":"https://api.github.com/repos/ged-lab/khmer/compare/{base}...{head}","merges_url":"https://api.github.com/repos/ged-lab/khmer/merges","archive_url":"https://api.github.com/repos/ged-lab/khmer/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/ged-lab/khmer/downloads","issues_url":"https://api.github.com/repos/ged-lab/khmer/issues{/number}","pulls_url":"https://api.github.com/repos/ged-lab/khmer/pulls{/number}","milestones_url":"https://api.github.com/repos/ged-lab/khmer/milestones{/number}","notifications_url":"https://api.github.com/repos/ged-lab/khmer/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/ged-lab/khmer/labels{/name}","releases_url":"https://api.github.com/repos/ged-lab/khmer/releases{/id}","created_at":"2012-05-15T03:52:53Z","updated_at":"2015-02-20T15:44:18Z","pushed_at":"2015-02-20T18:07:14Z","git_url":"git://github.com/ged-lab/khmer.git","ssh_url":"git@github.com:ged-lab/khmer.git","clone_url":"https://github.com/ged-lab/khmer.git","svn_url":"https://github.com/ged-lab/khmer","homepage":"http://khmer.readthedocs.org/","size":149575,"stargazers_count":201,"watchers_count":201,"language":"Python","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":153,"mirror_url":null,"open_issues_count":243,"forks":153,"open_issues":243,"watchers":201,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/ged-lab/khmer/pulls/799"},"html":{"href":"https://github.com/ged-lab/khmer/pull/799"},"issue":{"href":"https://api.github.com/repos/ged-lab/khmer/issues/799"},"comments":{"href":"https://api.github.com/repos/ged-lab/khmer/issues/799/comments"},"review_comments":{"href":"https://api.github.com/repos/ged-lab/khmer/pulls/799/comments"},"review_comment":{"href":"https://api.github.com/repos/ged-lab/khmer/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/ged-lab/khmer/pulls/799/commits"},"statuses":{"href":"https://api.github.com/repos/ged-lab/khmer/statuses/9ce38020208fdd30082a3f8e1f549a1919dfd476"}}}}