Skip to content

SUPPORT.md

Latest commit

 

History

History
163 lines (111 loc) · 5.78 KB

SUPPORT.md

File metadata and controls

163 lines (111 loc) · 5.78 KB
Raw

Support

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

Getting Help

Quick Links

Use our issue templates to get help quickly:

Report from Within the App

You can also report bugs and request features directly from Fire Tools:

  1. Open the app
  2. Go to Settings (gear icon)
  3. Scroll to Support & Feedback section
  4. Click the appropriate button to report a bug, request a feature, or suggest improvements

GitHub Issues (Primary Support Channel)

The primary way to get support is by opening an issue on GitHub using our templates:

👉 View all issue options

This allows the community to:

  • See and benefit from questions and answers
  • Search for similar issues before asking
  • Track progress on bug fixes and feature requests

What to Include in Your Issue

Our issue templates guide you through providing the right information. In general, include:

  1. A clear title - Summarize your question or problem
  2. Category - What type of issue is it?
  3. Detailed description - Explain what you're trying to do
  4. Steps to reproduce (for bugs) - Exact steps to recreate the issue
  5. Expected vs actual behavior - What should happen vs what happens
  6. Screenshots - Visual aids help immensely for UI issues
  7. Environment details:
    • Browser and version (e.g., Chrome 120, Firefox 121)
    • Operating system (e.g., Windows 11, macOS 14, Ubuntu 22.04)
    • Node.js version (if relevant for development)

Types of Support

Bug Reports

Found a bug? Report it here! Include:

  • Description of the bug
  • Bug category (UI, UX, calculation, data, performance)
  • Steps to reproduce
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages
  • Your browser and OS

Feature Requests

Have an idea for a new feature? Request it here! Include:

  • Description of the feature
  • Why it would be useful
  • How you envision it working
  • Any examples from other tools

Usage Questions

Need help using Fire Tools? Ask away! We're here to help you:

  • Understand how features work
  • Configure your FIRE calculations
  • Export and import your data
  • Troubleshoot issues

Documentation Issues

Found a typo or unclear documentation? Let us know:

  • What documentation is unclear
  • Where you found it
  • How it could be improved

Response Time

  • Initial response: We aim to respond to issues within 3-5 business days
  • Resolution time: Varies based on complexity and priority
  • Community help: Other users may respond sooner!

Please be patient - this is an open source project maintained by volunteers.

Community Resources

Documentation

Live Demo

Try the read-only demo (seeded sample data, nothing is saved): https://fire-tools-inc.github.io/app/demo/. For real use, download the desktop app.

What We Don't Support

Fire Tools is a free, open source tool for educational purposes. Please note:

  • ❌ Financial advice - We cannot provide personalized financial advice
  • ❌ Tax advice - Consult a tax professional for tax-related questions
  • ❌ Investment advice - Consult a financial advisor for investment decisions
  • ❌ Legal advice - Consult a lawyer for legal questions
  • ❌ Guaranteed accuracy - The tool makes assumptions and projections; actual results may vary

Always consult with qualified professionals before making financial decisions.

Commercial Support

Currently, Fire Tools does not offer commercial support or priority support options. All support is provided on a best-effort basis through GitHub Issues.

If you need professional assistance with financial planning, please consult a certified financial planner or advisor.

Self-Help Resources

Before opening an issue, you might find answers in:

  1. README.md - Basic usage and getting started
  2. Existing issues - Search closed and open issues
  3. Code comments - Check the source code for documentation
  4. Browser console - Look for error messages (F12 in most browsers)

Contributing

Want to help others or improve the project? Check out CONTRIBUTING.md to learn how you can:

  • Answer questions in issues
  • Fix bugs
  • Add features
  • Improve documentation

Code of Conduct

When seeking support, please follow our Code of Conduct. We strive to maintain a welcoming, inclusive, and respectful community.

Unacceptable behavior can be reported to: security@mb-consulting.dev

Feedback

We value your feedback! Let us know:

  • What's working well
  • What could be improved
  • What features you'd like to see
  • Your experience using Fire Tools

Your input helps make Fire Tools better for everyone!

Thank you for being part of the Fire Tools community! 🔥