rapidsai / rapidsai/pre-commit-hooks

Add hooks to lint conda recipes and pyproject.toml files

Open
#29 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
12
Avg merge
33m
Merged PRs (30d)
6

Description

Currently all of the non-dependency components of our package files are managed manually. This can lead to problems when some fields need to be specified in certain ways. It should be fairly trivial to implement a pre-commit hook that checks things like the license fields to ensure that they are appropriate. We could add as much complexity as we really need to handle various, although I'd probably err on the side of starting with only linting simple cases like common license typos and only adding more complex checks later if necessary.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's existing pre-commit hooks and the package metadata in pyproject.toml, then examine how conda recipe files are represented. Done means a hook checks the requested simple license-field cases, including common typos, for both conda recipes and pyproject.toml files, with coverage for the supported cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.