Skip to content

Support adding comments via the UI #13

@ojarjur

Description

@ojarjur

This issue is meant to track what would be required for the first steps in making the UI able to edit reviews rather than just display them. There are no current plans to do this, but this issue is here to document what would need to be done if someone else wants to pick that up.

There are two scenarios to consider:

  1. A hosted instance of the web UI that is visible to multiple people. An example would be https://git-appraise-web.appspot.com
  2. A locally running instance that is only accessible to one person (e.g. http://localhost:${SOME_PORT}).

The first scenario would require a full user-management setup and all of the complexity that entails, so I would not recommend considering that one until the second scenario is addressed.

For the second scenario, I think we would need at least the following:

  1. A new UI component for drafting the comments along with a preview of the rendered markdown. I think the editor that StackOverflow has is the best example of such a thing.
  2. An API for adding the comments. This would essentially just be a URL where the UI component can POST a JSON encoding of the comment. Of course, this would also entail adding a handler for that URL path.
  3. A button in the UI to push the newly written comments to a selected remote repository.

The button for pushing review data to (and, implicitly, pulling it from) a remote repository would also be useful in its own right, so that is probably the bit that should be done first.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions