Skip to content

How to Report a Bug or Suggest Content

hadcomfort edited this page Jun 12, 2025 · 1 revision

How to Report a Bug or Suggest Content

User feedback is the best way for us to improve the Veterans Information Resource. If you've found something wrong, confusing, or missing, we want to hear about it!

Before You Create an Issue

To help us manage feedback efficiently, please do a quick check first:

  1. Search existing issues: Your bug or suggestion might already be reported. You can search the issues here.
  2. Check the FAQ: The question you have might already be answered on our FAQ page.

Using GitHub Issues

The best way to report a bug or suggest a change is by creating a new issue in our repository.

➡️ Click here to create a new Issue

When you click the link, you'll be presented with several templates. Using these templates helps us gather all the information we need to address your feedback quickly.

Issue Templates

  • 🐛 Bug Report: Use this if something is broken. For example:

    • A link in the Advisor leads to the wrong page.
    • The site doesn't display correctly on your device.
    • An interactive element isn't working.
  • ✍️ Content Suggestion or Correction: Use this for issues with the text or logic. For example:

    • You found a typo or grammatical error.
    • A piece of information seems incorrect based on official sources.
    • A section in the Advisor or a guide is unclear.
  • ✨ Feature Request (Tool Enhancement): Use this to suggest a new feature or a significant improvement to the website or Advisor tool.

  • ❓ Question: If you have a general question about the project that isn't a bug or feature request, this is the right place.

Thank you for taking the time to help us improve this resource!

Clone this wiki locally