Skip to content

Help

This section provides information on how to get help with FastAPI Maintenance and how you can contribute to the project.

Getting Help

If you're having issues with FastAPI Maintenance, here are some resources to help you:

Documentation

The first place to look for help is the documentation itself. Make sure you've read through the relevant sections of the documentation.

GitHub Issues

If you've found a bug or have a feature request, please check the GitHub issues to see if it has already been reported. If not, feel free to open a new issue.

When reporting bugs, please include:

  • A clear description of the problem
  • Steps to reproduce the issue
  • Expected and actual behavior
  • Version information (Python, FastAPI, fastapi-maintenance)
  • Code samples or a minimal reproducible example

Discussions

For questions, ideas, or general discussions about the package, use the GitHub Discussions feature.

Support the Project

There are several ways you can support the FastAPI Maintenance project:

Star the Repository

If you find this project helpful, please consider giving it a star on GitHub. This helps others discover the project.

Spread the Word

Tell others about FastAPI Maintenance:

  • Write blog posts or tutorials about how you use the package
  • Share the project on social media
  • Mention it at conferences or meetups

Contributing

Contributions are welcome! You can:

  • Fix bugs or add features
  • Improve documentation
  • Write examples or tutorials
  • Add tests

If you want to contribute to the project, please see the Contributing guide for more information.

Report Issues

If you find bugs or have ideas for improvements, please report them on the issue tracker.