May 2018 OCaml DocJam Thread -- May 18, 19, 20

Everything I had in mind is written on the DocJam webpage, section “Contribution protocol”.

We suggest the following protocol for each participant. For details,
see the “Details” section below.

  • Decide on a project to look at, typically a project that you have
    used as a beginner in the not-so-distant past (we will discuss
    project suggestions during the event).

  • Perform a small improvement to its documentation, or a series of
    such improvement; if you apply patches to the project, they should
    get into a fresh branch of your clone of the repository.

  • Optionally, request some feedback on your proposed change to other
    participants: create a pull-request from your fresh branch to the
    master branch of your clone, and post it on the DocJam channels to
    ask for feedback.

  • Once you are satisfied with your patches, send it to the maintainers
    of the project. Log the submission in the “DocJam log” that collects
    all our Jam actions.

Feel free to suggest changes.