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

Document how to use the tool: rubycritic #232

Open
5 tasks
christinach opened this issue Sep 11, 2024 · 0 comments
Open
5 tasks

Document how to use the tool: rubycritic #232

christinach opened this issue Sep 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@christinach
Copy link
Member

christinach commented Sep 11, 2024

Introduction

  • Include rubycritic in our tools.

  • Document how to use it effectively to help refactor/cleanup our code

  • Provide examples from the requests form refactor work.

Acceptance criteria

  • Update an existing markdown document or add a new one in the docs directory.

  • It has introduction: Explains the goals and purpose of this documentation.

  • It has a step by step guide: Provides the exact steps to guide the user on how to use this tool.

Additional acceptance criteria

  • It includes references to the request form refactoring.
  • It includes a link to the rubycritic github repo
@christinach christinach added the documentation Improvements or additions to documentation label Sep 11, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant