Skip to content

Conversation

roy-shiloh
Copy link
Contributor

Updated docs for go command

PR Checklist

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • UI changes have been reviewed
  • No UI review needed

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Updated docs for go command
@roy-shiloh roy-shiloh requested a review from tal-rofe February 12, 2023 19:59
@linear
Copy link

linear bot commented Feb 12, 2023

EXL-37 Go Command

DOD:

  • Users should be able to get value as quickly as running a command, for users who do not yet use a compliance, even pre-authentication.
  • The run should make use of a recommended compliance based on our supported policies.
  • Should be conscious of the users language, and offer a relevant compliance. (i.e if a user is onboarding on a python repo, don't apply ESLint!)
  • Should funnel users to open a user, with the test run compliance opened as a group in the user's account.

Suggested workflow (open to changes tal)

  1. User types $ exlint go

  2. Ask the user for his needs: (Example only!) multi-select

    What languages are you using on this project? 
    🔥 JavaScript  
    🐍 Python   
    💻 TypeScript 
    🎨 CSS & HTML 
     ⚙ Go
    
  3. Describe the loading process like in use (display which policies are loading)

  4. Display the errors like in run

  5. Suggest the user to customize his configuration on our dashboard

    🚀 Customize & share this compliance by creating a user on our App!
    
     - Just type `exlint auth` and you will be directed to the Exlint App.
    

@tal-rofe tal-rofe merged commit 56108b0 into main Feb 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants