e5c16e8603
This commit adds a new SUPPORT.md file to the .github directory. This document provides a comprehensive guide for users of Tux, including a getting started guide, FAQs, bug reporting and feature request procedures, contribution guidelines, and contact information. This is done to improve user experience and provide necessary support information in a centralized location.
2.5 KiB
Support for Tux
Thank you for your interest in Tux, the all-in-one Discord bot for the All Things Linux Discord server. This guide will help you find the support you need to utilize Tux effectively.
Table of Contents
Getting Started
If you're just getting started with Tux, please refer to the README.md file in the repository for installation instructions, prerequisites, and a high-level overview of the project.
Frequently Asked Questions (FAQs)
Here are some commonly asked questions about Tux:
1. How do I install and set up Tux?
Refer to the README section "Installation" for detailed instructions on how to install and set up the bot.
2. Where can I find the development guide?
You can find the development guide in the docs directory at docs/development.md.
Bug Reports and Feature Requests
If you encounter any bugs or have feature requests, please follow these steps:
-
Search Existing Issues: Before creating a new issue, please search the existing issues to check if your concern has already been addressed.
-
Create a New Issue: If you can't find a relevant issue, you can create a new one. Ensure you provide detailed info, including steps to reproduce the issue, expected behavior & any relevant logs or screenshots.
Contributing
We appreciate and welcome contributions to Tux! If you're interested in contributing, please check out our Contributing Guide which provides guidelines on how to get started.
Contact Information
For additional help or questions that you can't find answers to, feel free to reach out to us through:
- Discord Support Server: atl.dev
- GitHub Issues: Tux Issues
We aim to respond to all queries as quickly as possible.
Thank you for using Tux and being a part of our community!