Skip to main content

Community

Welcome to the Dochia community! We're building a powerful API testing tool together, and we'd love your help to make it even better.

Getting Help

Documentation

GitHub Resources

Quick Help

# Get help with any command
dochia --help
dochia test --help

# Get environment information for bug reports
dochia info

# Check your version
dochia --version

Contributing

We welcome contributions from everyone! Here's how you can help:

Reporting Issues

Before reporting, please:

  1. Check existing issues to avoid duplicates
  2. Try the latest version to see if the issue is already fixed
  3. Review our Troubleshooting Guide

When reporting bugs, include:

  • Dochia version: dochia --version
  • Environment info: dochia info
  • OpenAPI spec (simplified/anonymized if needed)
  • Command used and full error output
  • Expected vs actual behavior

Issue Template:

## Bug Description

Brief description of the issue

## Environment

- Dochia version: [output of `dochia --version`]
- OS: [macOS/Linux/Windows]
- Environment: [output of `dochia info`]

## Steps to Reproduce

1. Run command: `dochia test -c api.yaml -s http://localhost:8080`
2. Observe error: [error message]

## Expected Behavior

What should have happened

## Actual Behavior

What actually happened

## Additional Context

Any other relevant information

Feature Requests

We love hearing your ideas! When requesting features:

  • Describe the problem you're trying to solve
  • Explain your proposed solution
  • Consider alternative approaches
  • Provide use cases and examples

Code Contributions

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a feature branch: git checkout -b feature/amazing-feature
  4. Make your changes
  5. Test your changes thoroughly
  6. Commit with clear messages: git commit -m "Add amazing feature"
  7. Push to your fork: git push origin feature/amazing-feature
  8. Open a Pull Request

Development Guidelines

  • Follow existing code style and conventions
  • Add tests for new functionality
  • Update documentation as needed
  • Keep commits focused and atomic
  • Write clear commit messages

Community Guidelines

Code of Conduct

We are committed to providing a welcoming and inclusive environment for everyone. We expect all community members to:

  • Be respectful - Treat others with kindness and respect
  • Be inclusive - Welcome newcomers and diverse perspectives
  • Be constructive - Focus on helping and improving
  • Be patient - Remember that everyone is learning
  • Be professional - Keep discussions on-topic and productive

Best Practices

When asking for help:

  • Search existing issues and documentation first
  • Provide clear, specific questions
  • Include relevant context and examples
  • Be patient while waiting for responses

When helping others:

  • Be kind and encouraging
  • Point to relevant documentation when helpful
  • Share your experience and solutions
  • Welcome questions from newcomers

Resources

Learning Resources

Tools and Integrations

  • Docker: docker pull dochiadev/dochia-cli:latest
  • Homebrew: brew install dochia-dev/tap/dochia-cli
  • CI/CD Examples: Check our documentation for integration guides

Feedback and Support

Ways to Provide Feedback

  • GitHub Issues: For bugs and feature requests
  • GitHub Discussions: For questions and general feedback
  • Documentation: Suggest improvements to our docs
  • Social Media: Share your experience using Dochia

Getting Support

  1. Check Documentation: Most questions are answered in our docs
  2. Search Issues: Someone might have had the same problem
  3. Ask in Discussions: For general questions and advice
  4. Create an Issue: For bugs or specific problems

Response Times

  • Critical bugs: We aim to respond within 24 hours
  • General issues: Usually within 2-3 days
  • Feature requests: May take longer to evaluate and plan
  • Community discussions: Response times vary

Recognition

We appreciate all contributions to Dochia! Contributors are recognized through:

Hall of Fame

  • Core Contributors: Regular contributors to code and documentation
  • Community Champions: Active helpers in discussions and issues
  • Documentation Heroes: Contributors who improve our docs
  • Bug Hunters: Users who report high-quality bug reports

Ways We Say Thanks

  • Recognition in release notes for significant contributions
  • Contributor mentions in documentation
  • Special badges for different types of contributions
  • Annual contributor highlights

Roadmap and Vision

Current Focus

  • Expanding playbook and mutator coverage
  • Add more generators for meaningful field values

Future Goals

  • Better CI/CD integration
  • Enhanced reporting capabilities

How You Can Influence

  • Vote on feature requests in GitHub issues
  • Participate in roadmap discussions
  • Share your use cases and requirements
  • Contribute code for features you need

Stay Connected

Updates

  • Watch our GitHub repository for release notifications
  • Star the project to show your support
  • Follow release notes for new features and improvements

Sharing

  • Blog posts: Write about your experience with Dochia
  • Conference talks: Present your API testing strategies
  • Social media: Share tips and success stories
  • Team adoption: Help your team adopt better API testing practices

Thank you for being part of the Dochia community! Together, we're making API testing more robust, automated, and accessible for everyone.