Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WP1 Selection Tools: Create a new list builder module #338

Open
audiodude opened this issue May 21, 2021 · 4 comments
Open

WP1 Selection Tools: Create a new list builder module #338

audiodude opened this issue May 21, 2021 · 4 comments

Comments

@audiodude
Copy link
Member

This issue is a master tracking issue for a P0 critical user journey for WP1 Selection Tools. This issue is not expected to be closed by a single PR, but rather for additional sub-issues to be attached to it.

The steps of the CUJ are:

  1. Although the WP1 selection tool provides already many way to create a list, a user may desire something else.
  2. The user creates a ticket in WP1 selection tool github repo
  3. The WP1 developers invite the user to create a new Python module in a form of a Python class implementing a specific 1. predefined/documented interface
  4. The user or a friend codes the module in Python in PR
  5. The module is reviewed, merged and deployed
  6. The user now has a new way to create list and use the module UI
@kelson42
Copy link
Collaborator

@audiodude Should we keep this ticket open? It seems the job is done so far to me.

@audiodude
Copy link
Member Author

This issue is really more of a "project" in github terminology, where each of the sub steps could be its own issue. It is tracking the steps for a contributor to add their own selection methods to WP1. It was an original goal of WP1 selection, but has been significantly put on the "back burner".

@kelson42
Copy link
Collaborator

@audiodude At this stage, the documentation about how to build a selection module is probably the only missing part. Seems important to me to ease onboarding of third parties.

@audiodude
Copy link
Member Author

My apologies if this isn't clear, but the real goal of this issue is that the potential contributor could write only python. So it encompasses a system where the parameters of the module are declared or inferred and the relevant UI is generated automatically.

Otherwise, step 4.5 would be "The user codes the frontend of the module in Vue Javascript and integrates it with the Python".

Really, without an API for parameters this does just boil down to a CONTRIBUTING doc that says "Yes, to add a module you have to do all these steps and become a WP1 contributor" as you implied.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants