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

As a Dev, I would to implement pre-commit Hooks for Code Quality and Consistency #1157

Open
1 task
ArthurData opened this issue Jul 17, 2024 · 1 comment
Open
1 task

Comments

@ArthurData
Copy link
Member

ArthurData commented Jul 17, 2024

User - Validation

  • grkstyle' style is apply at each commit

Dev - Tech

Using pre-commit in the golem package ensures high code quality and consistency. Pre-commit automates code checks before each commit, catching errors early and enforcing coding standards.

Benefits of pre-commit with golem:

  • Code Quality: Prevents bugs and inconsistencies by running tests and lints automatically.
  • Productivity: Automates repetitive checks, allowing developers to focus on complex tasks.
  • Consistency: Ensures uniform code style across all contributors.
  • Continuous Integration: Integrates smoothly with CI/CD systems, enforcing standards before merging.

Before to commit, we can:

  • Apply grkstyle,
  • Check for browser()

Estimated time

01h00.

@ColinFay
Copy link
Member

ColinFay commented Aug 2, 2024

Current thoughts:

  • For golem developers => using precommit as is, required Python but that's ok
  • For golem users:
    • new package called {golem.lint} with
      • golem_style()
      • sanity_check()
      • with_golem_precommit()
        • install precommit()
        • Check for precommit config
        • create a default precommit yaml with hooks from default precommit lib, from the R package, and from {golemlint}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants