fleet/CONTRIBUTING.md at 9ec90bfe6e6170f25b99549dc2d9ff400284dcbd

mirror of https://github.com/empayre/fleet.git synced 2024-11-06 17:05:18 +00:00

Provide documentation for reporting issues with the Fleet UI (#613 )

- Add 2 sections in `CONTRIBUTING.md` these 2 sections correspond to the "Bug report" and "Report a security vulnerability" issue templates
- Add "Is this an issue with the Fleet UI" to "Bug report" section in `CONTRIBUTING.md`. This includes a walkthrough for opening the browser's JS console and network requests
- Fix misspelled file name

2021-04-07 16:30:32 -07:00

1.3 KiB

Raw Blame History

Filing issues

Bug report

When filing an issue, make sure to answer these five questions:

1. What version of Fleet are you using?

Copy the version from the "My account" page in the Fleet UI (located below the "Get API token" button) or by run the fleetctl version --full command.

2. What operating system are you using?

3. What did you do?

4. What did you expect to happen?

5. What happened instead?

6. Is this an issue with the Fleet UI?

If the answer is no, you can leave this blank.

If yes, please provide a summary or screenshots of your browser's JavaScript console and your browser's network requests. Why? The information revealed in the browser's console and network requests kickstarts the debugging efforts and thus helps us resolve your issue faster!

To open your browser's Javascript console, press Control Shift J (Windows, Linux, ChromeOS) or Command Option J (macOS).

To open your browser's network requests, press Control Shift J (Windows, Linux, ChromeOS) or Command Option J (macOS). Then select the "Network" tab.

Report a security vulnerability

Sensitive security-related issues should be reported to security@fleetdm.com before a public issue is made.

1.3 KiB Raw Blame History