# Support

Thank you for using RenderSchema! This document explains how to get help with the project.

## Getting Help

### 📚 Documentation

Before asking for help, please check our documentation:

- **[README](../README.md)**: Project overview and quick start
- **[Quick Start Guide](QUICKSTART.md)**: Step-by-step tutorial
- **[API Documentation](API.md)**: Complete API reference
- **[Contributing Guide](CONTRIBUTING.md)**: How to contribute
- **[Changelog](CHANGELOG.md)**: Version history and changes

### 🐛 Bug Reports

If you've found a bug, please [open an issue](https://github.com/juliuspleunes4/RenderSchema/issues/new) with:

- Clear description of the problem
- Steps to reproduce
- Expected vs actual behavior
- Python version and OS
- RenderSchema version (`pip show renderschema`)
- Minimal code example that reproduces the issue

### 💡 Feature Requests

Have an idea for a new feature? [Open an issue](https://github.com/juliuspleunes4/RenderSchema/issues/new) describing:

- The problem you're trying to solve
- Your proposed solution
- Any alternatives you've considered
- Examples of how the feature would be used

### ❓ Questions

For questions about using RenderSchema:

1. **Check existing issues**: Someone may have already asked the same question
2. **Stack Overflow**: Tag your question with `renderschema` and `python`
3. **GitHub Discussions**: Start a discussion in our [repository](https://github.com/juliuspleunes4/RenderSchema/discussions)

### 📧 Direct Contact

For security vulnerabilities or private concerns, email **jjgpleunes@gmail.com**.

**Please do not email for general support questions** - use GitHub issues/discussions instead so others can benefit from the answers.

## Response Times

- **Bug Reports**: We aim to respond within 48 hours
- **Feature Requests**: Reviewed weekly, prioritized based on community interest
- **Security Issues**: Addressed within 48 hours (see [SECURITY.md](SECURITY.md))
- **Pull Requests**: Reviewed within 3-5 business days

## Community Guidelines

When seeking support:

- ✅ Be respectful and patient
- ✅ Provide complete information
- ✅ Search for existing solutions first
- ✅ Follow our [Code of Conduct](CODE_OF_CONDUCT.md)
- ❌ Don't cross-post the same issue in multiple places
- ❌ Don't demand immediate responses
- ❌ Don't include sensitive information in public issues

## Contributing

The best way to get help is often to help yourself (and others) by contributing:

- Fix bugs you encounter
- Improve documentation
- Add examples
- Write tests
- Review pull requests

See [CONTRIBUTING.md](CONTRIBUTING.md) for details.

## Useful Resources

### Python Diagramming Tools
- [Graphviz](https://graphviz.org/): Graph visualization library
- [PlantUML](https://plantuml.com/): UML diagram creation
- [diagrams](https://github.com/mingrammer/diagrams): Cloud system architecture diagrams

### Documentation Tools
- [Sphinx](https://www.sphinx-doc.org/): Python documentation generator
- [MkDocs](https://www.mkdocs.org/): Static site generator for project documentation
- [Read the Docs](https://readthedocs.org/): Documentation hosting

### UML & Architecture
- [UML Basics](https://www.uml-diagrams.org/): UML diagram reference
- [C4 Model](https://c4model.com/): Software architecture diagramming
- [ArchiMate](https://www.opengroup.org/archimate-forum): Enterprise architecture modeling

## Stay Updated

- ⭐ **Star the repository** to show support
- 👀 **Watch releases** for updates
- 📦 **Check PyPI** for new versions: https://pypi.org/project/renderschema/

## Acknowledgments

This project exists thanks to all contributors. Special thanks to everyone who:

- Reports bugs
- Suggests features
- Submits pull requests
- Improves documentation
- Helps others in discussions

Thank you for being part of the RenderSchema community! 🎉
