openlibhums / openlibhums/janeway

Free text form element

Open
#3,767 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

new feature Priority medium Size M
Dominant language
Python
Stars
238
Forks
97
Avg merge
9d 1h
Merged PRs (30d)
8

Description

Is your feature request related to a problem? Please describe.
We discovered an editor was attempting to add content to a review form that wasn't a question (e.g. some contextual text at the beginning and end of the form) by creating a new text field. I expect they thought they could do this because Google Forms has this option.

In this instance, the Editor had also left this hack-y field 'required' and so when the reviewer attempted to input their review, they overlooked the non-question fields and lost their review (resulting in #3766 )

2023-10-23_17-54-34

Describe the solution you'd like
2023-10-23_16-36-24
Add another option to 'kind' in the Review Form builder that lets an Editor insert text instead of a question, kinda like Google Forms does:
2023-10-23_19-36-56

Describe alternatives you've considered
Discouraging editors from attempting to use question fields to convey non-question information.

Additional context
This functionality could also be useful for dividing a Review Form up into sections, each with its own heading and description.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Review Form builder and the code that handles the existing field “kind” options. Trace how fields are created and rendered for editors and reviewers, then define the text option and section headings or descriptions described in the issue. Done means editors can insert non-question text without a required response and reviewers can submit forms without treating it as a question.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
web-dev
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.