Skip to content

Commit

Permalink
feat/fix: Update bugs_support_feedback.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sweep-ai[bot] authored Jan 25, 2024
1 parent 95b2d2d commit 8c42a98
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions terminal/faqs/bugs_support_feedback.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: Bugs and Support Feedback
---

## Reporting Bugs

If you encounter any bugs while using OpenBBTerminal, we appreciate your help in reporting them. To report a bug, please follow these steps:

1. Check the existing issues on the [GitHub repository](https://github.com/openbbterminal/openbbterminal/issues) to see if the bug has already been reported.
2. If the bug has not been reported, create a new issue on the repository with a clear and descriptive title.
3. In the issue description, provide detailed steps to reproduce the bug. Include any relevant code snippets, error messages, or screenshots.
4. Specify the version of OpenBBTerminal you are using, as well as the operating system and Python version.
5. If possible, provide a minimal, reproducible example that demonstrates the bug.

## Seeking Support

If you need support or have questions about using OpenBBTerminal, you can reach out to the community for assistance. Here are some ways to seek support:

1. Join the [OpenBBTerminal Discord server](https://discord.gg/openbbterminal) and ask your question in the appropriate channel.
2. Search the [OpenBBTerminal documentation](https://docs.openbbterminal.com) for relevant information and guides.
3. Check the [OpenBBTerminal FAQ](https://docs.openbbterminal.com/terminal/faqs) for answers to common questions.
4. If you believe you have found a bug, follow the steps outlined in the "Reporting Bugs" section.

## Providing Necessary Information

When reporting a bug or seeking support, it is important to provide the necessary information to help others understand and reproduce the issue. Here are some details you should include:

- The version of OpenBBTerminal you are using.
- The operating system and Python version you are using.
- Any relevant code snippets, error messages, or screenshots.
- Steps to reproduce the issue, including any specific inputs or configurations.

By providing these details, you can help others in the community better understand and address your issue.

## Steps to Reproduce Issues

When reporting a bug, it is helpful to provide clear and concise steps to reproduce the issue. Follow these guidelines to ensure your bug report is informative and actionable:

1. Start with a fresh installation of OpenBBTerminal.
2. Provide the necessary input data or configuration settings.
3. Describe the expected behavior.
4. Describe the actual behavior you observed.
5. Include any error messages or stack traces.

By following these steps, you can help others reproduce the issue and assist in finding a resolution.

0 comments on commit 8c42a98

Please sign in to comment.