Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Example Usage for JSON Output #70

Open
dealako opened this issue Mar 3, 2022 · 6 comments
Open

Add Example Usage for JSON Output #70

dealako opened this issue Mar 3, 2022 · 6 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@dealako
Copy link

dealako commented Mar 3, 2022

Summary

Add Example Usage for JSON Output

Background

Provide an example on the main readme page illustrating how to generate an output report in JSON format.

Tasks

  1. Add example command line usage showing how to generate a JSON report
  2. (Optional) Provide a sample (sanitized) JSON report and store it in this repository (allows consumers to see a working example report)

Acceptance Criteria

  1. Example usage displayed on the main readme page.
  2. (optional) users can view publically accessible example JSON report
@ljharb ljharb added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Mar 3, 2022
@ljharb
Copy link
Owner

ljharb commented Mar 3, 2022

Related: #68.

@ljharb ljharb added the enhancement New feature or request label Mar 3, 2022
@ljharb
Copy link
Owner

ljharb commented Mar 3, 2022

Part of this issue should definitely be to add --json support, so you can repo-report --json > report.json.

@abdumamdouh
Copy link
Contributor

@ljharb
does this one still needs work or it's already done?
if not can you assign it to me and @KhatiaIvanova

@ljharb
Copy link
Owner

ljharb commented Mar 11, 2022

It definitely still needs work :-)

@ljharb
Copy link
Owner

ljharb commented Mar 11, 2022

(I can't assign @KhatiaIvanova until they've commented on the issue)

@KhatiaIvanova
Copy link
Contributor

@ljharb assign this issue to me as well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants