{"action":"opened","issue":{"url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/issues/402","labels_url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/issues/402/labels{/name}","comments_url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/issues/402/comments","events_url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/issues/402/events","html_url":"https://github.com/california-civic-data-coalition/django-calaccess-raw-data/issues/402","id":102668080,"number":402,"title":"Add documentation for the ``mail_st`` field on the ``CvrCampaignDisclosureCd`` database model","user":{"login":"palewire","id":9993,"avatar_url":"https://avatars.githubusercontent.com/u/9993?v=3","gravatar_id":"","url":"https://api.github.com/users/palewire","html_url":"https://github.com/palewire","followers_url":"https://api.github.com/users/palewire/followers","following_url":"https://api.github.com/users/palewire/following{/other_user}","gists_url":"https://api.github.com/users/palewire/gists{/gist_id}","starred_url":"https://api.github.com/users/palewire/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/palewire/subscriptions","organizations_url":"https://api.github.com/users/palewire/orgs","repos_url":"https://api.github.com/users/palewire/repos","events_url":"https://api.github.com/users/palewire/events{/privacy}","received_events_url":"https://api.github.com/users/palewire/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/labels/documentation","name":"documentation","color":"eb6420"},{"url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/labels/enhancement","name":"enhancement","color":"84b6eb"},{"url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/labels/small","name":"small","color":"207de5"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/milestones/3","html_url":"https://github.com/california-civic-data-coalition/django-calaccess-raw-data/milestones/California%20Code%20Rush%202:%20Media%20Party%202015","labels_url":"https://api.github.com/repos/california-civic-data-coalition/django-calaccess-raw-data/milestones/3/labels","id":1268348,"number":3,"title":"California Code Rush 2: Media Party 2015","description":"A challenge to the crowd at the Media Party 2015 conference in Buenos Aires","creator":{"login":"palewire","id":9993,"avatar_url":"https://avatars.githubusercontent.com/u/9993?v=3","gravatar_id":"","url":"https://api.github.com/users/palewire","html_url":"https://github.com/palewire","followers_url":"https://api.github.com/users/palewire/followers","following_url":"https://api.github.com/users/palewire/following{/other_user}","gists_url":"https://api.github.com/users/palewire/gists{/gist_id}","starred_url":"https://api.github.com/users/palewire/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/palewire/subscriptions","organizations_url":"https://api.github.com/users/palewire/orgs","repos_url":"https://api.github.com/users/palewire/repos","events_url":"https://api.github.com/users/palewire/events{/privacy}","received_events_url":"https://api.github.com/users/palewire/received_events","type":"User","site_admin":false},"open_issues":111,"closed_issues":0,"state":"open","created_at":"2015-08-23T21:39:17Z","updated_at":"2015-08-23T22:44:11Z","due_on":"2015-08-30T03:00:00Z","closed_at":null},"comments":0,"created_at":"2015-08-23T22:44:11Z","updated_at":"2015-08-23T22:44:12Z","closed_at":null,"body":"\n## Your mission\n\nAdd documentation for the ``mail_st`` field on the ``CvrCampaignDisclosureCd`` database model.\n\n## Here's how\n\n**Step 1**: Claim this ticket by leaving a comment below. Tell everyone you're ON IT!\n\n**Step 2**: Open up the file that contains this model. It should be in <a href=\"https://github.com/california-civic-data-coalition/django-calaccess-raw-data/blob/master/calaccess_raw/models/campaign.py\">calaccess_raw.models.campaign.py</a>.\n\n**Step 3**: Hit the little pencil button in the upper-right corner of the code box to begin editing the file.\n\n![Edit](https://dl.dropboxusercontent.com/u/3640647/ScreenCloud/1440367320.67.png)\n\n**Step 4**: Find this model and field in the file. (Clicking into the box and searching with CTRL-F can help you here.) Once you find it, we expect the field to lack the ``help_text`` field typically used in Django to explain what a field contains.\n\n```python\neffect_dt = fields.DateField(\n    null=True,\n    db_column=\"EFFECT_DT\"\n)\n```\n\n**Step 5**: In a separate tab, open up the <a href=\"Quilmes\">official state documentation</a> and find the page that defines all the fields in this model.\n\n![The docs](https://dl.dropboxusercontent.com/u/3640647/ScreenCloud/1440367001.08.png)\n\n**Step 6**: Find the row in that table's definition table that spells out what this field contains. If it lacks documentation. Note that in the ticket and close it now.\n\n![The definition](https://dl.dropboxusercontent.com/u/3640647/ScreenCloud/1440367068.59.png)\n\n**Step 7**: Return to the GitHub tab.\n\n**Step 8**: Add the state's label explaining what's in the field, to our field definition by inserting it a ``help_text`` argument. That should look something like this:\n\n```python\neffect_dt = fields.DateField(\n    null=True,\n    db_column=\"EFFECT_DT\",\n    # Add a help_text argument like the one here, but put your string in instead.\n    help_text=\"The other values in record were effective as of this date\"\n)\n```\n\n**Step 9**: Scroll down below the code box and describe the change you've made in the commit message. Press the button below.\n\n![Commit](https://dl.dropboxusercontent.com/u/3640647/ScreenCloud/1440367511.66.png)\n\n**Step 10**:  Review your changes and create a pull request submitting them to the core team for inclusion.\n\n![Pull request](https://dl.dropboxusercontent.com/u/3640647/ScreenCloud/1440368058.52.png)\n\nThat's it! Mission accomplished!\n"}}