Are there guidelines for contributing to this project?

[ECAllen]

I didn't see a contributing doc but maybe I missed it. Are there any guidelines to contributing? or do we just do PRs?

[MarshalX]

Hi, sorry for the long response. Guidelines are very simple and most covered by CI/CD pipelines and will punish you if something goes wrong.

Long story short:

• You should just create PR to main.
• You should implement both async and sync interfaces which will be native without huge hacks around running in executor etc.
• You should type annotate the code. Each argument, each return type. The exclusion is only for things like *args and **kwargs; also we do not annotate self here. The linter will help you to not miss any type of annotation. You can go further and use pyright to verify your types
• You should format code. We are using ruff. For linting and formatting. So just run it locally and fix the errors before pushing.
• You should keep in mind that we are using code generators. Updated them if needed, and run before commiting. Sometimes they are naive and hacky. But they are here to simplify support of both sync and async interfaces.
• You should care about doc string for public methods. If you are developing a new module, you should include it in the docs. We also have .rst generator here.

That's probably it. And again, almost every step from this list is covered by CI