pendulum-chain / pendulum-chain/pendulum

Add Rust format checker to CI

Open
#477 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
45
Forks
13
Avg merge
5d 15h
Merged PRs (30d)
4

Description

Currently the formatting of code in PRs is not checked and therefore we have a lot of improperly formatted code on main (e.g., the spacing around the / operator is missing here).

This leads to a situation where some PRs happen to be overly bloated as they happen to correct the formatting of some code files that might not even be related to the PR.

TODO

  • add cargo fmt --check as a step to CI and let the action fail if it exits with non-0
  • apply proper formatting to the complete repository

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

Locate the repository's CI configuration and Rust workspace, then run cargo fmt --check to identify the current formatting failures. Add the check so CI fails on a nonzero exit status, format the complete repository, and verify that the check passes afterward.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.