You're encouraged to team up with a (new) friend and tackle something together!
Add a comment to the issue thread, saying that you're working on it so no one duplicates work.
At useR! Toulouse, we plan to pilot a post-it note based system for physically claiming an issue. Stay tuned.
If you work on an issue that doesn't already have the tidy-dev-day label, please comment requesting that @batpigandme add it. This makes it more visible to us and helps us track tidyverse developer day activities.
If you have never done a PR before, feel free to ask for help from any of the designated helpers. Our whole job today is to help people through these mechanics.
Happy Git describes some relevant workflows, such as:
- Fork and clone then Add the
upstream
remote - Push and pull when there are commits on GitHub that you don't have
The usethis article Pull request helpers shows how to work through a PR using the pr_*()
functions.
Sketch of R side (if working in a package)
- Fork and clone (see above) and create a new non-
master
branch.usethis::create_from_github()
+pr_init()
are great for this!
devtools::install_dev_deps()
to make sure you've got the necessary packages.devtools::check()
to get baseline, hopefully all is well.- Make your change. Add a test or two, if relevant.
- Iterate quickly with
load_all()
andtest()
.
- Iterate quickly with
devtools::document()
devtools::check()
to make sure all is still well.- Add a bullet to NEWS describing the fix or feature.
- Be concise, link to issue, tag yourself.
- Example: "
use_circleci()
creates a.circleci/config.yaml
config file for CircleCI (#703, @jdblischak)."
- Push and make a PR.
usethis::pr_push()
is great for this!- Make the title descriptive:
- Not good: "Working on issue 45"
- Much better: "Use stricter regexes for package and file name checks"
- Use the magic keywords, like "Closes #123", in the description, to hyperlink & close your issue.
- Example with descriptive title and description containing magic keywords: r-lib/usethis/#742
- 2019 July 8, before useR! Toulouse
- Room Ariane 1&2 on the first floor of main useR! venue = Centre de Congrès Pierre Baudis
- 9:00 AM to 5:00 PM (dev day itself); conference centre security opens at 8:30 AM
- Coffee breaks, lunch, and end-of-day apéritif all provided (thanks useR!)
- 2019 January 19th, following rstudio::conf (inaugural event).
Who? Anyone who would like to get better at contributing to the tidyverse! Everyone is welcome regardless of whether you've never done a PR before, or if you've already made your 10th package. But please get a ticket (see below).
What? A day of learning and coding. We'll provide food; you'll bring your laptop and enthusiasm. The tidyverse team and other community helpers will be on hand to help out and answer your questions.
The broad goal of this event is to nurture regular contributors to the tidyverse by having a day where we can work together on anything ranging from submitting your first pull request, to working on a package. The tidyverse team will be there, so we can help you hit the ground running and/or get over any stumbling blocks that you encounter. Don't have any ideas for something to work on? No problem! We'll be tagging issues in advance to make sure there's lots to do for any- and everyone, regardless of level of expertise.
Tickets are on sale now! sold out.
Tickets cost $10; we charge a small fee because space is limited and it decreases no-shows. All fees will be donated to a to-be-determined worthy organization.
All attendees are bound by the rstudio::conf Code of Conduct.
Feel free to open an issue here.