pull request updates: improve 'description'

Issue #99 new
Thomas De Schampheleire created an issue

Currently, updates to a pull request are marked in one big text area 'description' without structure. The resulting description, which is a combination of the manually entered description and 0 or more auto-generated update blocks, is not very readable.

Moreover, when v3 is created, there should only be a reference to v2. The reference to v1 is no longer necessary. Since currently this is free-text being appended, the reference remains.

It would be better if the status updates are handled in a separate field, so that the description is only used by the author himself. This will also allow for a more structured update and avoid references to older revisions but the previous one.

Comments (1)

  1. Mads Kiilerich

    It was done this way to get the main functionality and be able to experiment with it without committing to an actual data model ... and without doing data model changes. Yes, it should be replaced by a real data model.

    It is however intentional that we keep v1 in v3. We have found it very convenient to have the full history readily available. I suggest we keep it this way in the description field until we move it out and get a real model for it.

  2. Log in to comment