1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-11-28 01:32:42 +01:00
phorge-phorge/src/docs/contributor
epriestley 2823547f2c 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.

Reviewers: btrahan, chad

Reviewed By: chad

Subscribers: epriestley

Differential Revision: https://secure.phabricator.com/D8872
2014-04-26 22:30:19 -07:00
..
adding_new_css_and_js.diviner Add a basic CSS doc 2014-04-08 08:05:05 -07:00
contrib_intro.diviner Update contributor documentation 2014-04-26 22:30:19 -07:00
css_coding_standards.diviner Add a basic CSS doc 2014-04-08 08:05:05 -07:00
darkconsole.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
database.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
general_coding_standards.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
internationalization.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
javascript_coding_standards.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
n_plus_one.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
phabricator_code_layout.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
php_coding_standards.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
rendering_html.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
running_builtin_php_webserver.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
unit_tests.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
using_edges.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00
using_oauthserver.diviner Divide Phabricator documentation into four books 2014-03-05 13:00:24 -08:00