[tahoe-lafs-trac-stream] [Tahoe-LAFS] #4118: HOWTO Contributor/Developer guide

[Tahoe-LAFS]

#4118: HOWTO Contributor/Developer guide
-------------------------------+--------------------------------------
     Reporter:  blaisep        |      Owner:  blaisep
         Type:  enhancement    |     Status:  assigned
     Priority:  normal         |  Milestone:  User Documentation Goals
    Component:  documentation  |    Version:  n/a
   Resolution:                 |   Keywords:
Launchpad Bug:                 |
-------------------------------+--------------------------------------
Description changed by blaisep:

Old description:

> ### Contributor/Developer Guide (step-by-step)
> As a contributor, I need to create an environment that allows me to
>   - build Tahoe from source
>   - run the relevant CI
>   - observe the results
> So that I can make repairs and changes before submitting a PR.
>
> Background:
> The current [contributor guide](https://tahoe-
> lafs.readthedocs.io/en/latest/contributing.html) and
>  [release checklist](https://github.com/tahoe-lafs/tahoe-
> lafs/blob/master/CONTRIBUTORS.rst)
>
> does not
>   - step the reader through building the project from source
>   - describe the various relevant CI targets
>   - where to find the test results
>   - list the requirements for a PR
>   - find similar work in progress

New description:

 ### Contributor/Developer Guide (step-by-step)
 As a contributor, I need to create an environment that allows me to
   - build Tahoe from source
   - run the relevant CI
   - observe the results
 So that I can make repairs and changes before submitting a PR.

 Background:
 The current [contributor guide](https://tahoe-
 lafs.readthedocs.io/en/latest/contributing.html) and
  [release checklist](https://github.com/tahoe-lafs/tahoe-
 lafs/blob/master/CONTRIBUTORS.rst)

 does not
   - step the reader through building the project from source
   - describe the various relevant CI targets
   - where to find the test results
   - list the requirements for a PR
   - find similar work in progress

 also consider https://tahoe-lafs.org/trac/tahoe-lafs/wiki/CodingStandards

--

--
Ticket URL: <https://tahoe-lafs.org/trac/tahoe-lafs/ticket/4118#comment:3>
Tahoe-LAFS <https://Tahoe-LAFS.org>
secure decentralized storage