Ben Balter
@benbalter
@benbalter
Pull requests are a form of documentation. When authoring a PR, use the body as an opportunity to document the proposed change, especially the “why”, and cross link any related issues or other PRs to create a trail of breadcrumbs for future contributors. https://ben.balter.com/2023/05/19/pull-requests-are-a-form-of-documentations/
❗ Heads up! This Tweet is archived and here for historical purposes. It may no longer be accurate or reflect my views. Proceed at your own risk.
If you enjoyed this tweet, you might also enjoy:
- For the first time, the @WhiteHouse is using a pull request to propose c...
- Problem Child can now create pull requests. Simply add standard HTML fil...
- Hoping to make open source documentation (and other common @jekyllrb sit...
- TIL that RFC 2606 reserves `http://example.com` for use in documentation...
- "UK government 'has for the first time, mandated a preference for using ...
- In non-quake related news, latest version of Document Revisions (DMS for...
- Ladies and gentlemen, the future is here. @JBindelglass's first pull req...
- Maintainers will now see "first-time contributor" badges if it's the aut...
- 3. I took over GitHub Pages b/c I wanted pet features for my personal si...
- Why would anyone use blogger? (no really, why?)
- WP Document Revisions is looking for contributors. Let me know if you're...