aspect-build / aspect-build/rules_ts

[Bug]: pre-commit advice in CONTRIBUTING.md is at odds with the actual state of the repo

Open
#826 1 comment 0 reactions 0 assignees View on GitHub
bug
Dominant language
Starlark
Stars
138
Forks
87
Avg merge
2d 8h
Merged PRs (30d)
3

Description

### What happened?

The advice in CONTRIBUTING.md is to run pre-commit on your contributions.
However, when I ran `pre-commit run --all-files` it found formatting problems in 45 files that were unrelated to my contribution (for https://github.com/aspect-build/rules_ts/pull/825).
So,

1. Is the advice in CONTRIBUTING.md correct?
2. Are the formatting checks being enforced by your CI?
3. Do you want a PR consisting only of the formatting changes performed by `pre-commit run --all-files`?

### Version

Development (host) and target OS/architectures: MacOS Sequoia 15.5 / amd64

Output of `bazel --version`:

Version of the Aspect rules, or other relevant rules from your
`WORKSPACE` or `MODULE.bazel` file: HEAD

Language(s) and/or frameworks involved:

### How to reproduce

```shell
pre-commit run --all-files
```

### Any other information?

_No response_

Contributor guide

Open the contributing guide

Research direction

Read CONTRIBUTING.md and reproduce the issue with `pre-commit run --all-files`. Then inspect the repository's CI checks to compare the documented advice with what is enforced. Done means the expected contributor workflow and the decision about unrelated formatting changes are documented or otherwise resolved.

Written by the indexing model from the issue text.

Assessment

Domain
ci-cd, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.