Page MenuHomePhabricator

Update contributor documentation
ClosedPublic

Authored by epriestley on Apr 27 2014, 5:11 AM.
Tags
None
Referenced Files
Unknown Object (File)
Mon, Sep 9, 6:06 PM
Unknown Object (File)
Sun, Aug 25, 5:07 AM
Unknown Object (File)
Aug 19 2024, 3:57 AM
Unknown Object (File)
Aug 18 2024, 4:19 PM
Unknown Object (File)
Aug 17 2024, 1:34 AM
Unknown Object (File)
Aug 14 2024, 6:32 AM
Unknown Object (File)
Aug 6 2024, 3:37 PM
Unknown Object (File)
Jul 28 2024, 3:50 AM
Subscribers

Details

Reviewers
btrahan
chad
Commits
Restricted Diffusion Commit
rP2823547f2c70: Update contributor documentation
Summary

It's fairly common for people to show up and be interested in finding easy stuff to work on. This stuff basically doesn't exist and probably never will: it doesn't make much sense to deliberately leave easy bugs broken just because someone might show up and want to fix a couple of easy bugs.

Almost all of the work that's valuable to us requires a depth or bredth of context which can't be acquired in a few hours here and there, and probably always will. I think it also always should, in that as long as we continue refactoring and clearing technical debt aggressively and having solid static analysis support tools, we should never have a large backlog of human-intelligence codebase tasks. The closest we've ever come were probably pht() and phutil_tag(), which both have a lot of subtleties and we mostly automated phutil_tag() anyway. These tasks are also incredibly boring to write and review.

So, accept this as a reality and realign the contributor documentation to try to deal with this case:

  • Set expectations about starter tasks not existing and throwing a couple of hours at the project writing code being a hard path.
  • Suggest non-code contributions which anyone can do.
  • Segue into code contributions with context and suggestions.
Test Plan

Generated and read documentation.

Diff Detail

Repository
rP Phabricator
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

epriestley retitled this revision from to Update contributor documentation.
epriestley updated this object.
epriestley edited the test plan for this revision. (Show Details)
epriestley added reviewers: chad, btrahan.

Readable versions of the major bits:

Screen_Shot_2014-04-26_at_10.12.49_PM.png (851×804 px, 165 KB)

Screen_Shot_2014-04-26_at_10.12.56_PM.png (441×830 px, 79 KB)

chad edited edge metadata.

very nice, reads well.

This revision is now accepted and ready to land.Apr 27 2014, 5:18 AM

See also some discussion on Reddit:

Julia Evans has some really cool blog posts -- I found this one particularly interesting/impressive:

It looks like Stripe already snapped her up, though.

epriestley updated this revision to Diff 21049.

Closed by commit rP2823547f2c70 (authored by @epriestley).

src/docs/contributor/contrib_intro.diviner
59–65

is this a good opportunity to clarify Phacility's role here?

src/docs/contributor/contrib_intro.diviner
59–65

We should swap it over to the Phacility CLA, but we need to actually have that first.