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

Increase maintainability #1578

Open
halbGefressen opened this issue Dec 2, 2022 · 2 comments
Open

Increase maintainability #1578

halbGefressen opened this issue Dec 2, 2022 · 2 comments

Comments

@halbGefressen
Copy link

Is your feature request related to a problem? Please describe.
I have recently started to use Plover and like it quite a lot. But it has a few problems, thus I wanted to contribute to fixing them.
But I ran into the problem that the design seems unclear to me. Maybe it's just a skill issue though.

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like

  • A short paragraph in the "Contributing" section that explains the structure of the project would probably be beneficial.
  • Type annotations help a lot in understanding code that you don't know.
  • Maybe someone has another idea...

Describe alternatives you've considered
Not contributing at all... though I really don't wanna do that :)

@user202729
Copy link
Member

There's a bit of extra developer docs over in https://plover.readthedocs.io/en/latest/, have you read it?

@halbGefressen
Copy link
Author

I am currently reading the API docs, thank you for pointing me there. Couldn't find any conclusive article about the design structure, though, which is why I'm drawing some UML diagrams now (god help me). I'll try to get an overview on the project in the following days and maybe write a small paragraph about the structure. It seems to become a little clearer.

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