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.

Sign up for GitHub

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

Jump to bottom

Add first draft of a rule description style guide #4386

Merged
merged 16 commits into from Dec 30, 2021
Merged

Add first draft of a rule description style guide #4386

merged 16 commits into from Dec 30, 2021

Commits on Dec 19, 2021

  1. Add first draft of a rule description style guide

    @pnq32
    pnq32 committed Dec 19, 2021
    Configuration menu
    Copy the full SHA
    2aff63e View commit details
    Browse the repository at this point in the history

Commits on Dec 21, 2021

  1. Fix a typo in the style guide draft 

    Co-authored-by: Brais Gabín <braisgabin@gmail.com>
    @pnq32 @BraisGabin
    pnq32 and BraisGabin committed Dec 21, 2021
    Configuration menu
    Copy the full SHA
    4259f74 View commit details
    Browse the repository at this point in the history

Commits on Dec 23, 2021

  1. Update style guide to cover the three types of descriptions

    @pnq32
    pnq32 committed Dec 23, 2021
    Configuration menu
    Copy the full SHA
    ace5663 View commit details
    Browse the repository at this point in the history

Commits on Dec 24, 2021

  1. Discourage file names in code smell messages 

    Co-authored-by: Brais Gabín <braisgabin@gmail.com>
    @pnq32 @BraisGabin
    pnq32 and BraisGabin committed Dec 24, 2021
    Configuration menu
    Copy the full SHA
    511ab7b View commit details
    Browse the repository at this point in the history

  2. Fix two minor mistakes in the style guide

    @pnq32
    pnq32 committed Dec 24, 2021
    Configuration menu
    Copy the full SHA
    ddb44a8 View commit details
    Browse the repository at this point in the history

  3. Explain the example on usage-aware recommendations

    @pnq32
    pnq32 committed Dec 24, 2021
    Configuration menu
    Copy the full SHA
    24a8853 View commit details
    Browse the repository at this point in the history

  4. Reference the guide on authoing rule descriptions

    @pnq32
    pnq32 committed Dec 24, 2021
    Configuration menu
    Copy the full SHA
    6d7497d View commit details
    Browse the repository at this point in the history

Commits on Dec 29, 2021

  1. Write detekt in lowercase

    @schalkms
    schalkms committed Dec 29, 2021
    Configuration menu
    Copy the full SHA
    33a0ec6 View commit details
    Browse the repository at this point in the history

Commits on Dec 30, 2021

  1. Add an empty line after every heading 

    Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
    @pnq32 @schalkms
    pnq32 and schalkms committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    73e1a1e View commit details
    Browse the repository at this point in the history

  2. Clean up the contribution guide

    @pnq32
    pnq32 committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    4e20631 View commit details
    Browse the repository at this point in the history

  3. Incorporate latest review comments into the style guide

    @pnq32
    pnq32 committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    fd556c3 View commit details
    Browse the repository at this point in the history

  4. Fix a typo in the style guide

    @pnq32
    pnq32 committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    fb4da39 View commit details
    Browse the repository at this point in the history

  5. Use consistent line breaks in the style guide

    @pnq32
    pnq32 committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    61724a2 View commit details
    Browse the repository at this point in the history

  6. Merge the style guide into the contribution guide

    @pnq32
    pnq32 committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    78ed071 View commit details
    Browse the repository at this point in the history

  7. Delete the standalone style guide

    @pnq32
    pnq32 committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    f6bb1d3 View commit details
    Browse the repository at this point in the history

  8. Remove redundant space

    @schalkms
    schalkms committed Dec 30, 2021
    Configuration menu
    Copy the full SHA
    562ede3 View commit details
    Browse the repository at this point in the history