Contributions, Issues, and Pull Requests.

[jub0t]

I'm actively accepting contributions, ideas, bug reports, feature requests, etc. Please read the text below on how to get started on contributing.

Rules

• No Third Party API/Cloud integration such as voice generators, image generators, video generators, etc.
• No code-changes or pull-request out of the blue (will be rejected).

Pull requests:

• For the most part: Don't create pull-requests, use Issues or Discussions but if you do, follow the points below.
• Submit an idea, feature request, or similar in plain-text.
• For demonstration: Attach a small script (in python or a language of your choice). Really helpful.
• Fastest way to understand goals is to check the Roadmap section on the README.MD.

Bug reports:

• Try to include screenshots (really helpful).
• Provide steps to reproduce the bug/error.
• Provide some information about test-device for better understanding and debugging.
• Avoid technical clutter when creating an issue, a single understandable paragraph pinpointing the exact error is appreciated way more.
• Add code-blocks only when necessary, such as, when reporting logs or errors produced by the actual binary (the WolfCut app).

Things to keep in mind

• We are building this project for consumer grade Desktop devices, so any code or piece of software that is integrated into this app must run locally (no APIs) and must be performant and scalable enough to run on most devices (potatoes). Don't suggest things like "local image inference" or the likes unless you have a really compelling argument.

Pages:
Discussions: for Ideas, Suggestions, Requests, etc.
Issues: for Issues, Bug reports, etc.

[michaltomczykowski]

A small contributing.md with project scope/architecture/structure/passing tests would be kinda useful