{"action":"created","issue":{"url":"https://api.github.com/repos/forwards/tasks/issues/26","repository_url":"https://api.github.com/repos/forwards/tasks","labels_url":"https://api.github.com/repos/forwards/tasks/issues/26/labels{/name}","comments_url":"https://api.github.com/repos/forwards/tasks/issues/26/comments","events_url":"https://api.github.com/repos/forwards/tasks/issues/26/events","html_url":"https://github.com/forwards/tasks/issues/26","id":330822205,"node_id":"MDU6SXNzdWUzMzA4MjIyMDU=","number":26,"title":"Blog post based on Collaborative Coding slides","user":{"login":"cwickham","id":25964,"node_id":"MDQ6VXNlcjI1OTY0","avatar_url":"https://avatars2.githubusercontent.com/u/25964?v=4","gravatar_id":"","url":"https://api.github.com/users/cwickham","html_url":"https://github.com/cwickham","followers_url":"https://api.github.com/users/cwickham/followers","following_url":"https://api.github.com/users/cwickham/following{/other_user}","gists_url":"https://api.github.com/users/cwickham/gists{/gist_id}","starred_url":"https://api.github.com/users/cwickham/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cwickham/subscriptions","organizations_url":"https://api.github.com/users/cwickham/orgs","repos_url":"https://api.github.com/users/cwickham/repos","events_url":"https://api.github.com/users/cwickham/events{/privacy}","received_events_url":"https://api.github.com/users/cwickham/received_events","type":"User","site_admin":false},"labels":[{"id":945389611,"node_id":"MDU6TGFiZWw5NDUzODk2MTE=","url":"https://api.github.com/repos/forwards/tasks/labels/on-ramps-team","name":"on-ramps-team","color":"98e6f2","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":1,"created_at":"2018-06-08T22:38:12Z","updated_at":"2018-06-09T05:49:53Z","closed_at":null,"author_association":"NONE","body":"[Slides from useR! 2017](http://www.cwick.co.nz/talks/collab-code-user17/#/)\r\n\r\nWhile I think the slides did an OK job motivating people to contribute and maybe what types of contributions might be good to start with, it didn't really give enough detail for someone to get started.\r\n\r\nI think contributing to documentation is a great place to start, but if you are new to github and R packages, you might be wondering:\r\n* Where do I find the file to edit?\r\n* What is roxygen2 and why might it matter to a typo fix?\r\n* Is there any etiquette I need to know? \r\n\r\nAn idea I had done a little brainstorming on was a series of blog posts that walk though making pull requests on github that contribute to documentation in R packages, or related R resources (e.g. bookdown source).  Starting with the simplest case, edits that can be made entirely on the github website, and getting to a slightly more complicated case where you'd need to fork, clone in RStudio, edit, `document()`, `check()`, push, PR.\r\n\r\nHere's some notes I found on the matter that I'd written some time last year:\r\n\r\n# Fixing typos in R package documentation\r\n\r\nThings you can contribute to: \r\n\r\n* Help files displayed in R\r\n* README on github\r\n* Package vingettes\r\n* Package websites with source hosted on github\r\n\r\n# Why fix typos?\r\n\r\n* The maintainer will prefer a typo fix to a typo report. \r\n* It's low stakes. You are unlikely to break anything by fixing documentation, but it gives you practice contributing.\r\n* You can improve the experience for the next person who uses the documentation.\r\n\r\n## Easiest case\r\n\r\nThe typo can be fixed directly in the file on github.  This is super easy becasue you can do everything right on github.\r\n\r\nSteps:\r\n\r\n  1. Find the right file to make the change\r\n  2. Make the edit directly \r\n  3. Submit the pull request\r\n\r\nAppropriate when the content you are fixing is in a single file, and that file is not used to generate any other files in the repository.  It's easier to talk about exceptions, you can't use this method for:\r\n\r\n* R help documentation generated using roxygen2 \r\n* README.md when it is being generated by README.Rmd\r\n* website files (i.e. HTML) that are generated from RMarkdown\r\n\r\n\r\n## One step up\r\n\r\nThe typo needs the documentation to be regenerated.  \r\n\r\n\r\n```\r\n% Generated by roxygen2: do not edit by hand\r\n% Please edit documentation in R/plugin-providers.R\r\n```"},"comment":{"url":"https://api.github.com/repos/forwards/tasks/issues/comments/395942473","html_url":"https://github.com/forwards/tasks/issues/26#issuecomment-395942473","issue_url":"https://api.github.com/repos/forwards/tasks/issues/26","id":395942473,"node_id":"MDEyOklzc3VlQ29tbWVudDM5NTk0MjQ3Mw==","user":{"login":"hturner","id":3343008,"node_id":"MDQ6VXNlcjMzNDMwMDg=","avatar_url":"https://avatars3.githubusercontent.com/u/3343008?v=4","gravatar_id":"","url":"https://api.github.com/users/hturner","html_url":"https://github.com/hturner","followers_url":"https://api.github.com/users/hturner/followers","following_url":"https://api.github.com/users/hturner/following{/other_user}","gists_url":"https://api.github.com/users/hturner/gists{/gist_id}","starred_url":"https://api.github.com/users/hturner/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hturner/subscriptions","organizations_url":"https://api.github.com/users/hturner/orgs","repos_url":"https://api.github.com/users/hturner/repos","events_url":"https://api.github.com/users/hturner/events{/privacy}","received_events_url":"https://api.github.com/users/hturner/received_events","type":"User","site_admin":false},"created_at":"2018-06-09T05:49:53Z","updated_at":"2018-06-09T05:49:53Z","author_association":"MEMBER","body":"May we could tie in with hacktoberfest?"}}
{"actor":{"display_login":"hturner"}}