Skip to content

Conversation

possumbilities
Copy link
Contributor

@possumbilities possumbilities commented Jan 10, 2025

Description

  • sets baseline objects, arrays, etc.
  • confines various logic parts to functions
  • defines possible state paths through the stepper (of which there are 14 valid path routes)
  • tracks the parts of the path on change (updates state.parts)
  • updates the full state.current on change
  • compares the state.current to state.possibilities to determine license rec or error
  • roughly renders out the recommended license within the "license recommendation" area
  • includes working comments and some console.log statements for testing and debugging purposes

Technical details

  • ties stepper choice behavior to a dynamic state path that amends at each fieldset change
  • when a fieldset is changed, the current state is amended to reflect the updated state.parts, and then combined into the full updated state.current
  • state.current is compared to state.possibilities; if there is a match then a license rec can be made
  • if a rec matches, store that within state.props.license for use later
  • if a license rec can be made then the license recommendation is rendered with the appropriate license (for now it just replaces the placeholder title with a hyphenated one for testing).
  • the stepper begins with some fieldsets hidden, and based upon the resulting state from user choice additional fields are displayed or hidden to reflect the correct path flow.
  • some bugs remain in the logic, but that'll be worked out in the next batch of PRs (it still needs proper error handling as well), as well as resetting values if someone moves backwards in the steps.

Next up is building out a full render of the license in the "rec area" via a templated Web Component in a simplistic fashion (I'll probably just do one template per license and then refactor in future PRs to be more dynamic), and setting the stage for some error handling for when license is "unknown". Attached to or following that I'll work out the holes in the stepper rendering to smooth out any bugs.

Screenshots

Default load with cc-by

default-cc-by

State change upon selection of requisite fields for cc-0

defalult-cc0

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@possumbilities possumbilities marked this pull request as ready for review January 13, 2025 20:31
@possumbilities possumbilities requested review from a team as code owners January 13, 2025 20:31
@possumbilities possumbilities requested review from a team, akmadian and kgodey and removed request for a team and akmadian January 13, 2025 20:31
@possumbilities possumbilities changed the title setup baseline file for stepper logic setup baseline file for stepper logic, hide/show steps, adds minimal license rec capacity Jan 13, 2025
@possumbilities possumbilities removed the request for review from kgodey January 13, 2025 20:40
Copy link
Member

@Shafiya-Heena Shafiya-Heena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!!

@possumbilities possumbilities merged commit 7b2ea44 into refactor Jan 13, 2025
@possumbilities possumbilities deleted the stepper-flow branch January 13, 2025 21:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

2 participants