openclaw-assistant/CONTRIBUTING.md

Contributing to OpenClaw Assistant

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to OpenClaw Assistant. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report for OpenClaw Assistant. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

• Use a clear and descriptive title for the issue to identify the problem.
• Describe the exact steps to reproduce the problem in as many details as possible.
• Provide specific examples to demonstrate the steps.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for OpenClaw Assistant, including completely new features and minor improvements to existing functionality.

• Use a clear and descriptive title for the issue to identify the suggestion.
• Provide a step-by-step description of the suggested enhancement in as many details as possible.
• Explain why this enhancement would be useful to most OpenClaw Assistant users.

Pull Requests

The process described here has several goals:

• Maintain OpenClaw Assistant's quality
• Fix problems that are important to users
• Engage the community in working toward the best possible OpenClaw Assistant

Please follow these steps to have your contribution considered by the maintainers:

1. Fork the repository and clone it locally.
2. Create a new branch for your feature or fix: git checkout -b feature/amazing-feature or git checkout -b fix/annoying-bug.
3. Follow the local setup and build instructions in BUILDING.md.
4. Run the baseline checks before opening a PR:
   • cp app/google-services.json.example app/google-services.json
   • FIREBASE_ENABLED=false ./gradlew lintStandardDebug
   • FIREBASE_ENABLED=false ./gradlew clean testStandardDebugUnitTest
5. Commit your changes with a clear commit message.
6. Push to the branch: git push origin feature/amazing-feature.
7. Submit a pull request through GitHub.

Styleguides

Git Commit Messages

• Use the present tense ("Add feature" not "Added feature")
• Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
• Limit the first line to 72 characters or less
• Reference issues and pull requests liberally after the first line

Kotlin Style Guide

We follow the official Kotlin Coding Conventions.