Skip to content
OpenWaggle

Contributing

Report bugs, suggest features, and improve the documentation through GitHub issues.

OpenWaggle currently accepts community input through GitHub issues. Code pull requests are not yet accepted. See the repository’s CONTRIBUTING.md for the contribution policy.

Current contribution model

Open an issue with a bug report, feature request, documentation correction, or design proposal. You do not need to implement the change first. Browse existing issues before opening a new one.

The maintainers review issues and track planned work on the project roadmap.

How to contribute

Report bugs

Include enough information for someone else to reproduce the problem:

  1. Your operating system and OpenWaggle version.
  2. The steps you followed, what you expected, and what happened instead.
  3. The provider and model, if the problem concerns agent behavior.
  4. Relevant screenshots or logs. Remove credentials, private code, and personal information first.

If you are running from source, include the commit and Node.js version too. A small reproduction is more useful than a description of an entire project.

Suggest features

Describe the task you cannot complete, the workaround you use today, and the change you want. Mockups and concrete examples help. Discuss large architectural changes in an issue before implementing them.

Improve documentation

Link to the page and identify the missing, unclear, or incorrect instruction. Include the command or wording you tried and, when possible, a proposed correction.

What we’re looking for

Bug reports with reproduction steps, feature requests with concrete use cases, UI feedback, documentation corrections, and ideas for tools or integrations are welcome.

Code of conduct

  • Be respectful and constructive.
  • Focus on the problem, not the person.
  • Assume good intent from other contributors.

Future plans

The project intends to accept code contributions later. Until the policy changes, use issues for proposals. You can still build from source to investigate a problem locally.

Questions?

Open a GitHub Discussion or use the issue tracker.