mirror of
https://github.com/allthingslinux/tux.git
synced 2024-10-02 16:43:12 +00:00
feat: add SUPPORT.md to provide guidance for Tux users
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.
This commit is contained in:
parent
ea52d372ef
commit
e5c16e8603
1 changed files with 54 additions and 0 deletions
54
.github/SUPPORT.md
vendored
Normal file
54
.github/SUPPORT.md
vendored
Normal file
|
@ -0,0 +1,54 @@
|
|||
# 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
|
||||
|
||||
- [Support for Tux](#support-for-tux)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Frequently Asked Questions (FAQs)](#frequently-asked-questions-faqs)
|
||||
- [1. How do I install and set up Tux?](#1-how-do-i-install-and-set-up-tux)
|
||||
- [2. Where can I find the development guide?](#2-where-can-i-find-the-development-guide)
|
||||
- [Bug Reports and Feature Requests](#bug-reports-and-feature-requests)
|
||||
- [Contributing](#contributing)
|
||||
- [Contact Information](#contact-information)
|
||||
|
||||
## Getting Started
|
||||
|
||||
If you're just getting started with Tux, please refer to the [README.md](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](README.md) 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](docs/development.md).
|
||||
|
||||
## Bug Reports and Feature Requests
|
||||
|
||||
If you encounter any bugs or have feature requests, please follow these steps:
|
||||
|
||||
1. **Search Existing Issues**: Before creating a new issue, please search the existing [issues](https://github.com/allthingslinux/tux/issues) to check if your concern has already been addressed.
|
||||
|
||||
2. **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](CONTRIBUTING.md) 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](https://discord.gg/gpmSjcjQxg)
|
||||
- **GitHub Issues**: [Tux Issues](https://github.com/allthingslinux/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!
|
Loading…
Reference in a new issue