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

Integrate pre-commit and ruff for beginning the CI/CD process #65

Open
5 tasks
eronlloyd opened this issue Sep 28, 2024 · 0 comments
Open
5 tasks

Integrate pre-commit and ruff for beginning the CI/CD process #65

eronlloyd opened this issue Sep 28, 2024 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@eronlloyd
Copy link
Member

Description

As part of the important foundational preparations for our project, we need to integrate a CI/CD process to check code and data formats, tests, and documentation. To begin, we're going to use Git's pre-commit functionality managed by the Python package git-commit. The first pre-commit operation will be a code checker called ruff, followed by the test suites and other functions.

Requirements

  • Add pre-commit as a project requirement
  • Add ruff as a project requirement
  • Configure pre-commit to run ruff then all test suites

Dependencies

  • None

Tasks

  • Write unit tests
  • Write functional tests
  • Write docstring
  • Write code
  • Write documentation
@eronlloyd eronlloyd added the enhancement New feature or request label Sep 28, 2024
@eronlloyd eronlloyd self-assigned this Sep 28, 2024
@eronlloyd eronlloyd added this to the Release 0.1 milestone Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant