Support - edgeof8/tIRC GitHub Wiki

If you encounter issues with tIRC, have questions, or want to suggest features, here's how you can get support or contribute:

Reporting Issues (Bugs)

  • GitHub Issues: The primary place to report bugs or unexpected behavior is the Official tIRC GitHub Issues Page.
    • Before submitting a new issue, please search existing issues (open and closed) to see if your problem has already been reported or resolved.
    • When creating a new issue, provide as much detail as possible:
      • tIRC version.
      • Your operating system and terminal emulator.
      • Clear, step-by-step instructions to reproduce the issue.
      • Expected behavior vs. actual behavior.
      • Relevant snippets from log files (see Debugging And Logging). Sanitize any private information.
      • Screenshots, if applicable, especially for UI issues.

Feature Requests

  • GitHub Issues: You can also use the GitHub Issues Page to suggest new features or enhancements.
    • Clearly describe the feature and why it would be useful.
    • If possible, outline potential use cases.

Community Channels

(This section can be updated if tIRC establishes official community channels like an IRC channel, Discord server, or forum.)

  • At present, GitHub is the main hub for discussion and support. Check the main project README.md or website for any announcements regarding new community platforms.

Contributing

If you're interested in contributing code, documentation, or other improvements, please refer to the Contributing guide.

Asking for Help Effectively

When asking for help, whether on GitHub or other future community channels:

  1. Be Specific: Clearly describe the problem or question.
  2. Provide Context: Mention your tIRC version, OS, and any relevant configuration details.
  3. Explain What You've Tried: Detail any troubleshooting steps you've already taken (e.g., checking logs, restarting, disabling scripts). This saves time and helps others understand the scope of the issue.
  4. Include Logs/Errors: If you have error messages or relevant log snippets, include them (properly formatted, e.g., in code blocks, and sanitized of personal data).
  5. Be Patient: tIRC is an open-source project, and responses may depend on contributor availability.

By providing comprehensive information, you make it easier for others to understand your situation and offer effective assistance.