Journey to Maintainer- GitHub

Transcript

1. Journey to Maintainer By Katherine “Kati” Michel
2. About Me 2
3. Talk Goals • How I got my start in open source and maintaining • Technical aspects of being a Python package maintainer • Maintaining report card • Lessons learned
4. Milestone: Django Was Born, 2003
5. Django is Invented at LJW
6. If Only I Had Known
7. If Only I Had Known I was driving around the birthplace of Django and didn’t know it existed
8. Milestone: Becoming Interested in Tech, 2010
9. Intro to Tech
10. Milestone: Getting Started in Open Source, 2013
11. Announcing TacoFancy!
12. One Life Changing Question
13. My First Pull Request
14. Milestone: Learning the Fundamentals of Maintaining, 2017
15. DjangoCon US: The Conference with a Heart
16. DjangoCon US: The Conference with a Heart From my friend Mariatta’s ReadME Project page
17. DjangoCon US Website Pinax to... Jekyll
18. The Sites I’ve Overseen
19. Increase in Number of Contributors From 23 in 2016 To 65 in 2020
20. “Low Hanging Fruit” PRs 67 commits, including merging 28 PRs
21. That time I accidentally deleted the `dev` Branch One of the first things I did was the worst thing I ever thought I could do and it was liberating
22. I Learned So Much After that…
23. • Fetch a PR locally • Run the code • Merge a PR locally • Push a PR to a `master` branch • Push an update to a PR from a fork How To...
24. Created contributing docs and helped newcomers Also Became a Mentor
25. OS and Life Lesson: The Mistakes Disappear into the History • Open source has taught me it’s ok to have a beginner mindset; make mistakes, keep improving
26. First Tech Talk Photo by Adam Gregory of https://atomimages509.wixsite.com/atom
27. Get a Jumpstart on Collaboration and Code Review in GitHub • I made a talk about the mental model I had developed of how Git and GitHub work • I have given the talk to PyLadies, in particular
28. Mental Model • What GitHub is • “Shared Repository” versus “Fork and Pull” • A local development process • How to review pull requests as a maintainer • Tips for getting started
29. My All Time Favorite Piece of Git Code Push to a forked repo PR branch $ git push https://github.com/<user-name>/<repo-name> <local-branch-name>:<remote-branch-name>
30. Quality of Life • Technical skill set • Better pay • Attend conferences • Meet smart, interesting people • Travel to cool places
31. Second Chances On a “State of Django” panel with 3 LJW friends Me Frank Wiles, early LJW Simon Willison, Django co-creator Jeff Triplett, early LJW
32. Eating Dinner with Guido Me Guido
33. Milestone: Becoming a Python Package Maintainer, 2017
34. I Was Hired by Eldarion to Maintain Pinax Pinax: an open-source library of reusable Django starter projects, apps, and themes for building websites
35. The “Hot Club” Formed: 2007
36. Pinax Was Born: 2008
37. How It Began Personal Sites Inspiring Reusable Features
38. How It Began “Pinax is every idea I’ve ever had.”
39. How It Was Going 80 Projects and Apps account blog static stripe waitinglist zero company documents team-wiki wiki forums socialauth Pinax Themes Popular Pinax Apps Pinax Starter Projects django-user-accounts pinax-stripe pinax-announcements pinax-badges pinax-blog pinax-calendars pinax-cohorts pinax-comments pinax-documents pinax-eventlog pinax-events pinax-forums pinax-images pinax-invitations pinax-likes pinax-messages pinax-news pinax-notifications pinax-points pinax-ratings pinax-referrals pinax-submissions pinax-teams pinax-testimonials pinax-types pinax-waitinglist pinax-webanalytics pinax-wiki pinax-templates pinax-theme-bootstrap
40. How It Was Going GitHub Organization, Global Docs, and Slack
41. How It Was Going Sustainability lacking
42. Beginner Mindset
43. Simplified, Self-Service, Self-Sustaining
44. Vanilla Django Project Project Files Terminal $ django-admin startproject mysite .
45. Vanilla Django Apps Project and App Files Terminal $ python manage.py startapp myapp
46. Pinax CLI Terminal $ pip install pinax-cli $ pinax projects
47. Pinax CLI `startproject` is called from within the pinax-cli codebase Code Snippet
48. Pinax CLI Code Snippet starter project URL is passed in as a parameter
49. `projects.json` File File Snippet
50. Pinax Starter Projects • Pinax starter projects are in one repo • Each starter project is in an individual branch
51. Pinax Apps in Starter Projects Each starter project contains the relevant Pinax apps, to be installed from PyPI (the Python Package Index)
52. Pinax Apps Stand Alone Alternatively, Pinax apps can be used independently of any Pinax starter project Search “pinax” on PyPI
53. Maintaining Pinax Apps • GitHub Flow workflow • CalVer at release-level (year.month) • SemVer at app-level (major.minor.patch)
54. Pinax App Codebases Each Pinax app codebase lives in a GitHub repo
55. Professional Level Configs tox for testing CircleCI for continuous integration `setup.py` for packaging
56. Update the Test Matrix CircleCI Boilerplate tox Boilerplate
57. pyenv and tox pyenv can be used to install multiple global Python versions Then tox can run the test matrix Terminal
58. Python/Django Release Notes Tell you what changes have been made to the codebase in the release
59. Update SemVer Version and Changelog
60. Tag and Publish Tagging a release Published to PyPI
61. Pinax Report Card GitHub Open Source Guide “A Checklist Before You Contribute” is a good starting point
62. Pinax Seems Dead... TODO Group: “Shutting Down an Open Source Project”
63. But, Pinax is Still Being Used… A Lot? pinax-ratings has 1045 downloads per week and last release was by far most popular
64. But, Pinax is Still Being Used… A Lot? A query via BigQuery pinax-ratings has 27,550 downloads over 6 months!
65. Pinax Releases • Happening more regularly now • Keeps the code secure • Plus, access to new features
66. Docs and Standardization • Documented tribal knowledge • Made one source of docs, easy to find, use • Created detailed release and maintainer docs • Created community health files • Chose one configuration approach across projects
67. Community Engagement • Reduced the backlog of issues and PRs • Wrote more blog posts and publicized them
68. How It’s Going: 20.07 Release • 28 apps included • Support for Python 2.7 dropped • A huge milestone for me personally and professionally
69. How It’s Going: 21.05 Release
70. Updating the Test Matrix • Drop support for Django 3.0 • Continue support for Django 2.2, and Python 3.6, 3.7, and 3.8 • Add support for Django 3.1, 3.2, and Python 3.9
71. Small Improvements • Fix `setup.py test` deprecation • Fix isort deprecation • Add Black formatter
72. Documentation • Global documentation is in need of improvement • App specific docs should be double checked
73. Additional Automation • GitHub Action that runs tox • GitHub Action to auto-publish to PyPI upon tagging
74. Creating a Fork • pinax-starter-projects • pinax-cli
75. Lessons Learned • How to make a community self-sustaining
76. OS Social Contract “... open source maintainers owe you quite literally nothing when it comes to their open source code, and treating them poorly is unethical.” - Brett Cannon, Python Core Dev
77. The Link Between Django Core Dev and Pinax
78. Centralize Access and Knowledge • Centralize access • Be willing to hand access over • Avoid solutions that create gatekeeping
79. Managing Volunteer Maintainers • Give selective permissions • Protect branches • Require reviews
80. Reduce Scope • Mark repos as deprecated • Archive repos • Disable issues • Communicate that the code is maintained sporadically
81. Additional Automation • GitHub Actions • GitHub Apps • Probot
82. Is it Worth It? Yes :)
83. Is it Worth It? Yes :)
84. Q & A