Skip to content
OpenWaggle

Contributing

Report bugs, suggest features, send code contributions, and improve the documentation through GitHub.

You can help OpenWaggle by opening GitHub issues and sending pull requests: bug reports, feature requests, documentation fixes, UI feedback, design proposals, ideas for tools or integrations, and code changes. The repository’s CONTRIBUTING.md has the full policy.

You do not need to write the change yourself. Search the existing issues first, in case someone has already reported it. The maintainers review new issues and track planned work on the project roadmap.

Report a bug

Give enough detail 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 is about agent behavior.
  4. Screenshots or logs that show the problem. Remove credentials, private code, and personal information first.

The repository’s issue forms ask for these details when you open the issue.

If you run OpenWaggle from source, add the commit and your Node.js version. A small reproduction helps more than a description of a whole project.

Suggest a feature

Describe the task you cannot do, the workaround you use today, and the change you want. Mockups and concrete examples help. Open an issue to discuss a large architectural change before anyone builds it.

Fix the documentation

Link to the page and point out the instruction that is missing, unclear, or wrong. Include the command or wording you tried and, if you can, the correction you suggest.

Send a pull request

Start from an issue, keep each pull request one coherent change, and follow the commit and verification standards the repository CI enforces. CONTRIBUTING.md describes them. You can build OpenWaggle from source to check a fix on your own machine first.

Submitting a contribution accepts the project’s Contributor License Agreement. You keep the copyright of your work. CLA Assistant checks every pull request. Agree once in its comment and your later pull requests are covered automatically. A pull request without the CLA status cannot merge.

Ask a question

Start a GitHub Discussion, or open an issue.

Be kind

  • Be respectful and constructive.
  • Talk about the problem, not the person.
  • Assume other contributors mean well.