MOOSE / DOCUMENTATION

Contributing

Bug reports, code, documentation, and design feedback are welcome.

Report a problem

Search the existing issues before opening a new one. Include:

  • Moose version, Linux distribution, and installation method.
  • Steps to reproduce the problem, what you expected, and what happened.
  • Model and Ollama version when the issue involves a response or connection.
  • A relevant screenshot or error message, if useful.

Remove private conversations, documents, credentials, and server details before sharing screenshots or logs.

Suggest an idea

Describe what you are trying to do and how a change would help. Discuss larger features or interface changes in an issue before starting. Small fixes can go straight to a pull request.

Work on a change

Fork the repository, clone your fork, and create a branch from main. Follow the build instructions.

Keep a change focused on one problem and follow the surrounding code. Use English for original text and keep the interface simple and consistent with Moose.

For database changes, add a migration instead of editing an existing one. When dependencies change, keep Cargo.lock and cargo-sources.json in sync.

Send a pull request

Send your pull request to main. Explain the problem, resulting behavior, and how you checked the change. Include screenshots for interface changes and link related issues.

Read the project’s full contribution guide for current checks and submission guidance. Documentation and thoughtful feedback are contributions too.