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

Write Docs on How To Add A Feature/Functionality #153

Closed
6 tasks
TTWNO opened this issue Sep 1, 2024 · 0 comments · Fixed by #154
Closed
6 tasks

Write Docs on How To Add A Feature/Functionality #153

TTWNO opened this issue Sep 1, 2024 · 0 comments · Fixed by #154

Comments

@TTWNO
Copy link
Member

TTWNO commented Sep 1, 2024

Steps are roughly:

  • Find event that corresponds to the desired feature
  • Decide if there are any pre-requisites to the feature being triggerwd (think: focused window only, open tab only, etc.)
  • See if the prerequisite is already defined (we have some for only focused window events for example)
  • Decide what, if any, state is required for your feature (caret position, last focused item, etc.)
  • Check to see if we already have your state info as a type (if not, make a newtype and implement FromAsyncState for it)
  • Implement a new function that takes PreRequisiteType<EventType>, and StateType. That function can retuen a list of Commands that Odilia will act on.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant